請求書作成・管理サービスMakeLeaps APIをドライバー化：各種ツールから連携

CData Drivers MakeLeaps ODBC API Driver Excel Power BI Access ソリューションとユースケース

by 杉本和也 | 2021年01月18日

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

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

f:id:sugimomoto:20210112152754p:plain

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

対象 API
実現イメージ
各種接続シナリオと必要なツール
終わりに

対象 API

「MakeLeaps」は、見積書から請求書までクラウド上で作成&共有が可能なSaaS型アプリケーションです。

https://www.makeleaps.jp/

f:id:sugimomoto:20210112152800p:plain

MakeLeaps では、商品マスタや連絡先、書類の取得・作成・更新などが可能なAPIが提供されており、外部アプリケーション等との連携も実現できるようになっています。

https://app.makeleaps.com/api/docs/

f:id:sugimomoto:20210112152807p:plain

実現イメージ

この記事では MakeLeaps APIに対してExcelやPower BIといった各種ツールやIDEからの接続方法を紹介します。しかしながら、各APIは単純にツールと接続・連携することはできません。

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

f:id:sugimomoto:20210112152817p:plain

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

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

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

f:id:sugimomoto:20210112152822p:plain

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

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

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

Excel（Excel-addin で利用）
Access（ODBC 接続で利用）
PowerBI （Power BI Connector 接続で利用）

上記以外のツールからの接続に関しては、以下のページで各種接続方法記事を公開しています。

www.cdata.com

f:id:sugimomoto:20201124135144p:plain

テーブル一覧

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

テーブル名	対応API	備考
Clients	クライアント組織
Contacts	連絡先
DocumentLineItems	書類	書類の明細情報を表示します。
Documents	書類	書類のヘッダー情報を表示します。
Employees	メンバー
Histories	履歴
Items	商品一覧
Partners	自社情報
SendingOrderItems	送付依頼	送付依頼の明細情報を表示します。
SendingOrders	送付依頼	送付依頼のヘッダー情報を表示します。

MakeLeaps API 利用準備

最初にMakeLeapsのAPIを利用するために、MakeLeaps側でAPIキーを作成します。

MakeLeaps にログインした状態で以下のURLにアクセスし、任意の名称を入力の上、「APIキーを追加」をクリックします。

https://app.makeleaps.com/integrations/makeleaps/api-users/

f:id:sugimomoto:20210112152829p:plain

クリック後、以下のようにClientId・Client Secretが発行されるので、これを控えておきます。

f:id:sugimomoto:20210112152837p:plain

また、MakeLeaps Idも必要になるので控えておきましょう。

f:id:sugimomoto:20210112152845p:plain

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

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

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

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

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

f:id:sugimomoto:20210112152852p:plain

CData API Driver のインストール

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

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

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

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

f:id:sugimomoto:20201027111336p:plain

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

f:id:sugimomoto:20201027111341p:plain

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

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

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

| プロパティ名 | 値 | 備考 | |---|---|---| | Profile | C:\API Profiles\MakeLeaps.apip | 予めダウンロードしたMakeLeaps.apipのパスを指定します。 | | ProfileSettings | MakeLeapsID=2871743999064770271; | 接続対象のMakeLeaps Idを指定します。 | | AuthScheme | OAuth | | | Initiate OAuth | GETANDREFRESH | アクセストークンの更新方法を指定します。 | | OAuth Client Id | 例）API2920304278873886495 |登録したMakeLeaps APIキーのClient Idを指定します。 | | OAuth Client Secret | 例） YHUbWlIhXcKQN6yr7Jf6Kxw3ctBHLqxYQHiSu0KiaiXiHtToUZ1urxTC1yPRu8OIQt4eppBviJhd2L3f | 登録したMakeLeaps APIキーのClientSecretを指定します。 |

f:id:sugimomoto:20210112152859p:plain