こんにちは。CData Software Japanリードエンジニアの杉本です。

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

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

対象 API

ユビレジはiPadで手軽に利用できるクラウドベースのPOSレジサービスです。

詳しくは以下のURLからどうぞ。

ユビレジ APIでは、メニュー・商品情報、顧客情報や支払い情報を取得するAPIが提供されています。

実現イメージ

この記事ではユビレジ APIに対してBIツールやIDEでから接続します。しかしながら、各APIは単純にツールと接続・連携することはできません。

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

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

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

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

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

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

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

最初にユビレジのAPIを利用するために、ユビレジ側でAPIの有効化設定を行います。

まず、設定画面にアクセスし「システム連携」→「API アクセストークン」をクリックします。

次に「新しく作成」をクリックし

任意の名前を入力し、「作成」をクリックすることでAPI Tokenが生成されます。

作成完了後、「表示」をクリックすることで生成されたAPI Tokenを取得できます。

この以下の文字列のTokenを後ほど利用するので、控えておきましょう。

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

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

保存先フォルダは後ほど使用するので「C:\APIProfiles\Ubiregi」といった書き込み可能な任意のフォルダに配置してください。

各種ツールとユビレジ API を繋ぐために必要となるCData API Driverをインストールします。

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

まず、CData API ODBC Driverの30日間の評価版をダウンロードします。ダウンロードの際には、Emailの登録が必要となります。

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

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

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

以下の項目をセットし、保存します。

プロパティ名	値	備考
Profile	C:\APIProfiles\Ubiregi\Ubiregi.apip	予めダウンロードしたUbiregi.apipのパスを指定します。
ProfileSettings	APIKey=XXXXX;MenuId=XXXX;	APIKeyには予め取得したAPI Tokenを指定します。MenuIdはユビレジ管理画面、メニュー設定のURLから取得できる5桁の数値です。