楽楽明細のAPI をドライバー化：各種ツールから接続してみた

CData Drivers 楽楽明細 JDBC ODBC API Excel Add-in Power BI ソリューションとユースケース

by 杉本和也 | 2022年02月18日

f:id:sugimomoto:20220217195240p:plain

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

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

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

楽楽明細とは
実現イメージ
各種接続シナリオと必要なツール
終わりに

楽楽明細とは

電子請求書発行システム「楽楽明細」は、請求書、納品書、支払明細などの帳票をWEB上で発行するクラウド型のシステムです。

www.rakurakumeisai.jp

楽楽明細ではAPI 連携機能（オプション）が提供されています。

API	取込（登録）
顧客データCSV 一括取込 API	*
顧客データ一括取込状況取得API
帳票データCSV 一括取込 API	*
帳票ファイル一括取込API	*
帳票データ一括取込状況取得API
帳票一括取込情報取得API
帳票一括取込情報削除API
顧客情報取得API （一括）
顧客情報取得API （個別）
顧客情報削除API
顧客情報変更差分取得API
帳票情報取得API
帳票一括取得情報検索API
帳票一括取得API

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

実現イメージ

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

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

f:id:sugimomoto:20220217195248p:plain

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

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

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

f:id:sugimomoto:20220217195255p:plain

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

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

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

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

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

www.cdata.com

f:id:sugimomoto:20201120133303p:plain

テーブル（ビュー）一覧

CData API Drvier で楽楽明細 APIに接続するためには専用の設定ファイル（Profile）が必要になります。

楽楽明細 API Profile では、以下のテーブル（ビュー）を提供しています。用途に合わせて、接続してみてください。

Name	Resource	備考
Customers	顧客情報取得 API（一括）
Reports	帳票情報取得 API

API トークンの取得

楽楽明細API に接続するためにAPI トークンが必要となります。楽楽明細であらかじめ取得しておいてください。

f:id:irokawah:20220216204802p:plain

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

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

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

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

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

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

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

f:id:sugimomoto:20220217195305p:plain

CData API Driver のインストール

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

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

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

www.cdata.com

f:id:sugimomoto:20201027111336p:plain

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

f:id:sugimomoto:20201027111341p:plain

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

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

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

プロパティ名	値	備考
Profile	C:\APIProfiles\RakurakuMeisai.apip	予めダウンロードした楽楽明細 .apipのパスを指定します。
ProfileSettings	Domain=your_domain;Account=your_account;APIKey=your_apiky;	接続先となるDomain・AccountとAPI Keyを指定します。

f:id:sugimomoto:20220217195315p:plain

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

f:id:sugimomoto:20210813162426p:plain

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

Excel から楽楽明細 API に接続（Excel Add-in for API）

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

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

f:id:sugimomoto:20201116171024p:plain

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

f:id:sugimomoto:20220217195320p:plain

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

f:id:sugimomoto:20220217195325p:plain

f:id:sugimomoto:20220217195329p:plain

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

f:id:sugimomoto:20220217195333p:plain

Access リンクテーブルから楽楽明細 API に接続（CData API ODBC Driver）

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

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

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

f:id:sugimomoto:20210813162454p:plain

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

f:id:sugimomoto:20210813162459p:plain

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

f:id:sugimomoto:20220217195339p:plain

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

f:id:sugimomoto:20220217195343p:plain

設定後、リンクテーブルが追加され、以下のように楽楽明細のデータを閲覧することができるようになります。もちろん、通常通りクエリデザイナーでも使用可能です。

f:id:sugimomoto:20220217195348p:plain

PowerBI から楽楽明細 API に接続（CData API Driver for Power BI）

続いて CData ODBC Driverを用いて、Power BIから楽楽明細の商品データを取得します。

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

f:id:sugimomoto:20201027111449p:plain

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

f:id:sugimomoto:20201027111519p:plain

データソース名は先程登録した楽楽明細のDSNを入力し「OK」をクリックします。

f:id:sugimomoto:20220217195355p:plain

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

f:id:sugimomoto:20220217195359p:plain

以下のように楽楽明細のデータを読み込みことができます。

f:id:sugimomoto:20220217195404p:plain

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

f:id:sugimomoto:20220217195409p:plain

ASTERIA Warp から楽楽明細 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）に登録します。

f:id:sugimomoto:20210218152238p:plain

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

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

f:id:sugimomoto:20210216154030p:plain

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

f:id:sugimomoto:20220217195417p:plain

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

プロパティ名	値	備考
ドライバーのパス	例）C:\asteriahome5\system\lib\drivers\cdata.jdbc.api.jar	前節でインストールした API JDBC Driverファイルへの参照を指定します。
URL	jdbc:api:Profile=C:\API Profiles\RakurakuMeisai.apip; ProfileSettings="Domain=your_domain; Account=your_account; APIKey=your_apiky;";