サスケWorksのAPI をドライバー化：各種ツールから接続してみた

by 菅原和義 | 2022年06月01日

こんにちは。CData Software Japan テクニカルサポートエンジニアの菅原です。

本記事では、各種 Web API を ODBC / JDBC / ADO.NET といった標準のDB接続規格でアクセスできるようにするCData API Driverを用いて、サスケWorks の API を各種ツールから接続する方法を紹介します。

ExcelやAccess・Tableau などのエンドユーザーが利用するUIベースのツールはもちろん、Visual StduioやEclipseといった開発ツールからも接続することが可能です。

サスケWorks とは
実現イメージ
各種接続シナリオと必要なツール
終わりに

サスケWorks とは

サスケWorksはプログラミングの知識がなくてもドラッグ＆ドロップの直感的な操作で、使う現場や目的に合わせた業務効率化アプリを作ることができるサービスです。

https://works.saaske.com/

サスケWorksではAPI 連携機能が提供されています。

※サスケWorks APIを利用するには、Premiumプランのご契約が必要となります。

https://works.saaske.com/api/document.html

API	API Profileの備考
アプリ一覧の取得
アプリ詳細の取得
レコード一覧（固定リスト）	各アプリの項目を静的な項目として事前に定義する必要があります
一括登録設定の取得
カスタムリスト一覧取得
ファイルの取得
ユーザー一覧の取得
ユーザー詳細の取得
レコード一括登録	API Profileでは不可
一括登録作業データの削除	API Profileでは不可

※レコード一覧（固定リスト）については、各アプリ毎にカスタマイズが必要となります。今回は「顧客管理×売上管理」をターゲットとしました。別アプリやカスタマイズしたアプリに対応するには、各アプリ毎に「レコード一覧（固定リスト）」を事前に定義する必要があります。

本記事では、このAPIを用いて様々なツールとの連携を実現します。

実現イメージ

この記事ではサスケWorks APIに対してBIやETL/EAIなど、様々なツールから接続します。しかしながら、各APIは単純にツールと接続・連携することはできません。

各ツールがどのようにWeb API側へリクエストを投げるべきかの判断材料や各種認証方法の処理、メタデータの情報等が無いためです。そのためには基本的にカスタムコネクタを作るか、プログラムを組まなければいけません。

そこで、CData API Driver を用いて、このボトルネックを解決します。

まず、各ツールからはODBCやJDBCインタフェースでSQL（Select文）をCData API Driverに向けて発行してもらいます。そのリクエストを受け取った CData API Driverは、サスケWorks の API のエンドポイントに対して、SQL文を解釈し、HTTPリクエスト発行します。

リクエスト後、JSONフォーマットで返ってきたデータをCData API Driverが各種インタフェースフォーマットにデータを変換してツールに返します。

これにより、各種ツールからアドホックにSQLによるリクエストがあったタイミングで最新のデータをサスケWorks API から取得することが可能となります。

各種接続シナリオと必要なツール

CData API Driver は様々なツールとの接続に利用できますが、今回は以下のツールを用いて接続する方法を解説していきます。

Excel（Excel-addin で利用）
Access（ODBC 接続で利用）
Tableau （Tableau Connector 接続で利用）
CDataSync

なお、CData API Driverは上記以外にも様々なツールと連携することが可能です。

www.cdata.com

テーブル一覧

CData API Drvier でサスケWorks APIに接続するためには専用の設定ファイル（Profile）が必要になります。今回作成したサスケWorks API Profile では、以下のテーブルを提供しています。

※レコード一覧（固定リスト）については、各アプリ毎に必要となります。今回は「顧客管理×売上管理」をターゲットとしました。別のアプリに対応するにはXXX_recordsのように各アプリ毎にテーブルを定義する必要があります。

Name	Resource
app	アプリ一覧の取得
apps	アプリ詳細の取得
CRM_records	レコード一覧（固定リスト）：「顧客管理×売上管理」
user	ユーザー一覧の取得
users	ユーザー詳細の取得

APIキー・APIアクセストークンの取得

サスケWorks API に接続するためにAPIキー・APIアクセストークンが必要となります。サスケWorksであらかじめ取得しておいてください。取得方法はサスケWorksのサイトにも詳しく記載されておりますので、ご確認ください。

https://works.saaske.com/api/document.html#section/Works-API/APIAPI

API データ処理用設定ファイル（API Profile）を作成

続いて、サスケWorks の API を CData API Deiver が解釈できるように設定ファイル（API Profile）を作成します。

すでに私が作成したものがあるので、以下のURLからダウンロードしてください。

https://cdatajbuilds.s3.ap-northeast-1.amazonaws.com/APIProfiles/SaaskeWorks.apip

保存先フォルダは後ほど使用するので「C:\APIProfiles\SaaskeWorks.apip」といったツールからアクセスが可能な任意のフォルダに配置してください。

なお、サスケWorks のカラムなどは自由にカスタマイズすることができます。apipファイルは一度zipに拡張子を変更することで中を確認できます。

以下のような項目定義がXMLで行われているので、ご利用中の環境に合わせて、チューニングしてみてください。

API Profileの制約

今回サンプルとして作成しましたAPI Profileには下記のような制約があります。

①読み取り専用のため、登録・更新・削除を行うことができません。

②別アプリやカスタマイズしたアプリに対応するには、そのアプリ毎に設定されたオブジェクト名をAPI Profileに事前に定義する必要があります。

※例えばオブジェクト名が変更になった際にも、その都度API Profileの定義も変更する必要があります。

CData API Driver のインストール

各種ツールとサスケWorks API を繋ぐために必要となるCData API Driverをインストールします。

基本的なインストール・設定方法は各種Driver共通ですので、ここではODBC Driverを例に説明します。

まず、CData API ODBC Driverの30日間の評価版をダウンロードします。

www.cdata.com

ダウンロードしたsetup.exeファイルをBIツールがインストールされているマシンにインストールします。インストールウィザードに従い、EULAを確認した上でインストールを完了します。

※途中、ライセンスサーバーへのオンラインアクティベーションが行われるためネットワーク環境に接続されている必要があります。

インストールが完了すると、ODBCのDSN設定のウィンドウが立ち上がります。

以下の項目をセットし、「接続のテスト」をクリックします。

プロパティ名	値	備考
Profile	C:\APIProfiles\SaaskeWorks.apip	サスケWorks.apipのパスを指定します。
ProfileSettings	APIKey=XXXXX;Token=YYYYY;	接続先となるAPIKey・Tokenを指定します。