BtoBプラットフォーム請求書 の API をドライバー化：各種ツールから接続してみた

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

本記事では、各種 Web API を ODBC / JDBC / ADO.NET といった標準のDB接続規格でアクセスできるようにするCData API Driverを用いて、BtoBプラットフォーム請求書 の API を各種ツールから接続する方法を紹介します。

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

対象 API

BtoBプラットフォーム請求書 とは 電子帳簿保存法・インボイス制度に対応したクラウド請求書サービスです。

https://www.infomart.co.jp/seikyu/index.asp

BtoBプラットフォーム請求書では、請求データの取得や請求書の登録・更新APIが提供されており、外部ツールやサービスと連携が実現できるようになっています。

https://www.infomart.co.jp/products/cooperation/api/index.asp

今回はこのAPIを用いて様々なツールとの連携を実現します。

実現イメージ

この記事では BtoBプラットフォーム請求書 APIに対してBIやETL/EAIなど、様々なツールから接続します。しかしながら、各APIは単純にツールと接続・連携することはできません。

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

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

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

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

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

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

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

• Excel（Excel-addin で利用）
• Access（ODBC 接続で利用）
• PowerBI （Power BI Connector 接続で利用）
• ASTERIA Warp（JDBC Driver 接続で利用）
• CDataSync

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

https://www.cdata.com/jp/kb/tech/rest-article-list.rst

テーブル（ビュー）一覧

CData API Drvier で BtoBプラットフォーム請求書 APIに接続するためには専用の設定ファイル（Profile）が必要になります。

BtoBプラットフォーム請求書 API Profile では、以下のテーブル（ビュー）を提供しています。用途に合わせて、接続してみてください。

なお、発行側と受取側で利用できるテーブルが異なります。接続に使用するユーザーアカウントによって変わるので注意してください。

BtoBプラットフォーム請求書 API 利用準備

最初にBtoBプラットフォーム請求書のAPIを利用するために、BtoBプラットフォーム請求書側でアプリケーション登録を行います。

利用開始のための手続きは以下のリンクを参考にしてください。

https://www.infomart.co.jp/products/cooperation/api/index.asp

リダイレクト先のURLはドライバーの場合だと「http://localhost:33333」、CData Sync の場合は「http://localhost:8019/src/oauthCallback.rst」を指定します。

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

続いて、BtoBプラットフォーム請求書 の API を CData API Deiver が解釈できるように設定ファイル（API Profile）を作成します。

以下のページからダウンロードしておきます。

https://www.cdata.com/jp/apidriver/download/

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

CData API Driver のインストール

各種ツールとBtoBプラットフォーム請求書 API を繋ぐために必要となるCData API Driverをインストールします。

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

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

https://www.cdata.com/jp/apidriver/download/

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

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

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

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

これで CData API Driver からの接続が完了します。

それでは実際に各種ツールからの接続方法を解説していきましょう。

Excel から BtoBプラットフォーム請求書 API に接続（Excel Add-in for API）

CData Excel Add-in for API をインストール後、Excelを立ち上げるとCDataタブが追加されていることがわかります。このタブから各種操作を実施します。

接続を開始するには、CDataタブから［取得元 API］をクリックします。

最初に接続するためのウィザードが表示されるので、「CData API Driverのインストール」の内容と同様に各種パラメータを入力します。

接続後、対象テーブルを選択し、クエリを編集の上、「OK」をクリックします。

クリック後、対象のデータが一括で取得できます。

Access リンクテーブル から BtoBプラットフォーム請求書 API に接続（CData API ODBC Driver）

次はCData ODBC Driverを利用して、Access リンクテーブルから接続してみたいと思います。

あらかじめ新規にAccessを立ち上げて、空のデータベースを作成しておきましょう。

続いて「外部データ」タブから「新しいデータ ソース」→「他のソースから」→「ODBC データベース」を選択します。

ウィザードが表示されるので「リンクテーブルを作成」を選択し、「OK」をクリックします。

データソースの選択では「コンピューターデータソース」から事前に作成したCData API Driver用DSNを選択し「OK」をクリック

テーブルの一覧が表示されるので、任意のテーブルを選択し「OK」をクリックします。

設定後、リンクテーブルが追加され、以下のようにBtoBプラットフォーム請求書のデータを閲覧することができるようになります。もちろん、通常通りクエリデザイナーでも使用可能です。

PowerBI から BtoBプラットフォーム請求書 API に接続（CData API Driver for Power BI）

最後にCData Power BI API Connector を用いて、Power BIからBtoBプラットフォーム請求書のデータを取得します。

PowerBI Desktopを起動して、「データを取得」をクリックします。

データ接続先一覧の中から「CData API」を選択し、「接続」をクリックします。

データソース名は先程登録したBtoBプラットフォーム請求書のDSNを入力し「OK」をクリックします。

テーブルの一覧から対象となるテーブルを選択し「読み込み」をクリックします。

以下のようにBtoBプラットフォーム請求書のデータを読み込みことができます。

あとはPoewr BIの機能を用いて、ビジュアライズに利用することができます。

ASTERIA Warp から BtoBプラットフォーム請求書 API に接続（CData JDBC API Driver）

ASTERIA Warpでは、フローデザイナーを使って、データ処理のプロセスを作成します。

フローデザイナーの基本的な利用方法についてはWarpのフローデザイナー操作ガイドをご覧ください。

CData JDBC API Driver はインストール後、「cdata.jdbc.api.jar」と「cdata.jdbc.api.lic」のファイルをAsteriaのドライバーフォルダ（asteriahome5\system\lib\drivers）に登録します。

その後、ASTERIA Warpを立ち上げて、フローデザイナーにアクセスし、CData JDBC Driverを使用するために接続を追加します。

画面左のコネクションペイン上にある電源ボタンをクリックをクリックすると、「コネクションの作成」ダイアログが表示されます。

「接続種別」として「RDB」を選択、「名前」に分かりやすい名前を設定し「OK」をクリックします。

作成したコネクションをダブルクリックすると、画面右のインスペクタに接続プロパティが表示されます。
「基本」タブでドライバーのパスとURLをそれぞれ設定します。

構成後、「接続のテスト」を実行して、成功すればOKです。

これでコネクションの作成は完了です。あとは、フロー上でデータベースタブにある「RDBGet」のコンポーネントを使って、データの取得が行なえます。

「RDBGet」フローに配置し、ダブルクリックします。

コネクションの選択ウインドウが表示されるので、先程作成したBtoBプラットフォーム請求書のコネクションを選択しましょう。

その後、SQLビルダーが表示されるので、取得したいデータが格納されている、任意のテーブルとカラムを選択します。

あとは、「モデルにSQLを適用する」をクリックし「SELECTテスト」でデータが正常に取得できているかを確認します。

以下のようにデータが参照できれいればOKです。設定を保存してSQLビルダーを閉じます。

あとは Asteria Warp の機能で様々なサービスとのデータの連携を実現できます。

CData Sync から BtoBプラットフォーム請求書 に接続

CData Sync ではデータソースとして、BtoBプラットフォーム請求書に接続することができます。

なお、CData Sync Windows版の場合は「Infomart.apip」のプロファイルをSyncの本体が存在するフォルダの「www\app_data\profiles」に配置してください。profilesフォルダが存在しない場合は手動で作成してください。

> C:\ProgramData\CData\sync\profiles

Cross-Platform版の組み込みJettyで構成している場合は、以下のフォルダにapipファイルを配置します。

> /opt/sync/profiles

配置後、CDataSyncを起動すると以下のようにデータソースとして BtoBプラットフォーム請求書が利用できるようになります。

接続プロパティは以下の通り設定します。

入力後、「接続」ボタンをクリックし、接続テストが完了すればOKです。

併せて、任意の同期先の接続情報も構成しておきましょう。

接続完了後、新しくジョブを作成します。

先程作成した BtoBプラットフォーム請求書 のコネクションを選択します。

ジョブを作成した後は、BtoBプラットフォーム請求書 の同期対象となる任意のテーブルを選択しましょう。

データのプレビュー画面で、実際に取得が成功しているかどうかを確認できました。

あとは、任意のスケジュールを指定してデータのレプリケーションを実行できます。

試しに手動で実行してみると、それぞれのレプリケーション件数が結果として表示されます。

RDBの中でもレプリケーションされたデータが確認できました。

Tips

いくつかのテーブルでは条件指定が必須のものが存在します。例えば「BuyerInvoiceData」「BuyerInvoiceDataDetails 」「BuyerInvoiceDataBanks」は以下のようにReceptionDate で取得したいデータの範囲を指定する必要があります。

SELECT * FROM BuyerInvoiceData WHERE ReceptionDate >= '2022-01-13' and ReceptionDate <= '2022-01-14';

SELECT * FROM BuyerInvoiceDataDetails WHERE ReceptionDate >= '2022-01-13' and ReceptionDate <= '2022-01-14';

SELECT * FROM BuyerInvoiceDataBanks WHERE ReceptionDate >= '2022-01-13' and ReceptionDate <= '2022-01-14';

また、「GetDataType」で取得するデータの種類を指定することも可能です。

SELECT * FROM BuyerInvoiceData WHERE ReceptionDate >= '2022-01-13' and ReceptionDate <= '2022-01-14' and GetDataType = 0;

「SellerInvoices」「SellerInvoiceDetails」「SellerInvoiceBanks」は「TargetDate」による日付範囲の指定が必要です。

SELECT * FROM SellerInvoices WHERE TargetDate >= '2022-01-13' and TargetDate <= '2022-01-14';

SELECT * FROM SellerInvoiceDetails WHERE TargetDate >= '2022-01-13' and TargetDate <= '2022-01-14';

SELECT * FROM SellerInvoiceBanks WHERE TargetDate >= '2022-01-13' and TargetDate <= '2022-01-14';

終わりに

これら以外にもCData API Driver は各種ETLツールや帳票ツールなどからも接続することが可能です。

以下のCData オンラインナレッジベースには、各種ツールからの接続方法を紹介した記事が多数掲載されているので、是非見てみてください。

https://www.cdata.com/jp/kb/

不明な点があれば、テクニカルサポートまでお気軽にどうぞ！

https://www.cdata.com/jp/support/submit.aspx

関連コンテンツ