本記事ではAPI Driver for JDBCの利用手順を解説します。

API Driver for JDBCのダウンロードとインストール

１．下記よりAPI Driver for JDBCをダウンロードし、インストールウィザードの指示にしたがってインストールを行います。

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

API Profileのダウンロード

２．下記より利用したいデータソース（API）のAPI Profileをダウンロードします（本記事では例として「freee Accounting API Profile」を利用します）。

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

３．２でダウンロードしましたAPI Profileを各種ツールやプログラム（プログラミング言語）からアクセス可能なフォルダ（例：C:\API Profiles）に保存（移動）します。

接続文字列の作成

４．API Driver for JDBCのインストールディレクトリ「lib」にある.jarファイルを実行します。

５．Connection Builderが開きます。

６．［Profile］に３で保存（移動）したAPI Profileのフルパス（例：C:\API Profiles\freeeAccounting.apip）を入力します。

７．［接続プロパティ］のその他の項目へ接続に必要な情報を入力していきます。

必要な接続情報については、下記のような流れで各API Profileのオンラインヘルプページにてご確認いただけますが、接続情報はデータソース側であらかじめ設定したり、確認や取得を行ったりといった事前作業が必要となり、その手順はデータソースごとに異なります。

ですので、入力情報の設定や確認、取得方法が不明な場合は、画面右上の「お問い合わせ」などからお気軽にお問い合わせください。

７－１．API Profileのオンラインヘルプページを開きます。

オンラインヘルプページは、例えば下記ページのデータソース名 > ヘルプドキュメントより開くことが可能です。

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

７－２．オンラインヘルプページの項目「Connecting to XX」を開きます。

例えば、データソース＝freee Accountingの場合、接続方法は「Using OAuth Authentication（OAuth認証）」であることがわかります。

また、必要な情報の取得方法などが記載されていることが確認できます。

設定可能なオプションについての情報も確認できます。

７－３．７－２で確認した情報を用いて、［接続プロパティ］の各項目へ接続に必要な情報を入力していきます。

（例）データソース＝freee Accountingの場合

７－２で確認した情報を踏まえると、CompanyId、Authscheme、OAuthClientID、OAuthClientSecret、CallbackURL、InitiateOAuthの入力が必要となりますが、CompanyIdについては「And, You get CompanyId from Comapnies view.（そして、CompanyIdはCompaniesビューから取得します。）」と、freee Accountingとの接続が確立した後に取得可能なデーブル・ビューの方で確認するよう指示されているので、まずはCompanyId以外の情報を入力します。

８．［接続テスト］をクリックします。

９．表示される指示にしたがって必要な設定をすすめます。データソースによっては、このステップが生じない場合もあります。

（例）データソース＝freee Accountingの場合

（１）Webブラウザが立ち上がり、アクセスの許可を実施します。

（２）下記のページが表示されたらWebブラウザを右上の「✕」などで閉じます。

１０．メッセージ「接続テストに成功しました」が表示されたら［OK］をクリックします。

※なお、データソース＝freee Accountingの場合、ここでCompanyIdの確認と入力を行います。

（１）タブ［データモデル］を開き、左側のテーブル・ビュー一覧から［Companies］を選択、タブ［クエリ］の［実行］をクリックすると、Companiesのデータが取得されますので、アクセスしたい事業所の［Id］を控えます。

（２）タブ［接続］を開き［ProfileSettings］に「CompanyId=」につづけて、（１）で確認したIdを入力します。

※［ProfileSettings］に複数のプロパティを入れる必要がある場合は「；（セミコロン）」で区切りながら入力してください。
（例）CompanyId=1234567;XXXXX=XXXXX;

（３）［接続テスト］をクリックし、メッセージ「接続テストに成功しました」が表示されたら［OK］をクリックします。

１１．期待どおりデータが取得できるか確認します。タブ［データモデル］を開き、左側のテーブル・ビュー一覧から適当なテーブル・ビューを選択、タブ［クエリ］の［実行］をクリックして、データが取得されることを確認します。

（例）Banksのデータを取得

１２．タブ［接続］を開き［コピー］をクリックし、接続文字列をコピーします。

ツール・プログラム（プログラミング言語）からデータを取得する

１３．利用するツール・プログラム（プログラミング言語）からJDBCデータソースを呼出して、利用します（１２でコピーした接続文字列を使ってデータソースと接続します）。

さいごに

API Driver for JDBCの基本の利用の流れは以上のとおりです。

特に手順の７や１３のあたりは、接続したいデータソースの種類により手順の詳細が異なる部分ですので、ご不明な場合はお気軽にお問い合わせフォームなどからおたずねください！