本記事ではAPI Driver for ODBCの利用手順を解説します。
API Driver for ODBCのダウンロードとインストール
1.下記よりAPI Driver for ODBCをダウンロードし、インストールウィザードの指示にしたがってインストールを行います。
https://jp.cdata.com/apidriver/download/
API Profileのダウンロード
2.下記より利用したいデータソース(API)のAPI Profileをダウンロードします(本記事では例として「freee Accounting API Profile」を利用します)。
https://jp.cdata.com/apidriver/download/
※API Profileとは?
API Driverを介してSQLでクエリ(問い合わせ)したいAPIのスキーマ(データ構造)などをまとめた定義ファイルのサンプルです。
定義ファイルは
ご自身で作成いただくことも可能ですが、弊社ではいくつかのAPIについてAPI Profileという形であらかじめご用意しております。
3.2でダウンロードしましたAPI Profileを各種ツールやプログラム(プログラミング言語)からアクセス可能なフォルダ(例:C:\API Profiles)に保存(移動)します。
DSN構成と接続テスト
4.スタートメニューなどの検索ボックスに[ODBC]と入力・検索し、[ODBC データソース]を開きます。
5.[ODBC データソース アドミニストレータ―]のタブ[ユーザー DSN](あるいは[システム DSN])を開き[CData API Source](あるいは、[CData API Sys])を選択し、右側の[構成]をクリックします。
※API Driver for ODBCをインストールしたマシンを複数のユーザーでご利用の場合に、API Driver for ODBCをご自身のユーザーアカウントのみで使用する場合は[ユーザー DSN]、全てのユーザーで使用する場合は[システム DSN]を開いてください。
6.[接続プロパティ]の[Profile]に3で保存(移動)したAPI Profileのフルパス(例:C:\API Profiles\freeeAccounting.apip)を入力します。
7.[接続プロパティ]のその他の項目へ接続に必要な情報を入力していきます。
必要な接続情報については、下記のような流れで各API Profileのオンラインヘルプページにてご確認いただけますが、接続情報はデータソース側であらかじめ設定したり、確認や取得を行ったりといった事前作業が必要となり、その手順はデータソースごとに異なります。
ですので、入力情報の設定や確認、取得方法が不明な場合は、画面右上の「お問い合わせ」などからお気軽にお問い合わせください。
7-1.API Profileのオンラインヘルプページを開きます。
オンラインヘルプページは、例えば下記ページのデータソース名 > ヘルプドキュメントより開くことが可能です。
https://jp.cdata.com/apidriver/
7-2.オンラインヘルプページの項目「Connecting to XX」を開きます。
例えば、データソース=freee Accountingの場合、接続方法は「Using OAuth Authentication(OAuth認証)」であることがわかります。
また、必要な情報の取得方法などが記載されていることが確認できます。
設定可能なオプションについての情報も確認できます。
7-3.7-2で確認した情報を用いて、[接続プロパティ]の各項目へ接続に必要な情報を入力していきます。
(例)データソース=freee Accountingの場合
7-2で確認した情報を踏まえると、CompanyId、Authscheme、OAuthClientID、OAuthClientSecret、CallbackURL、InitiateOAuthの入力が必要となりますが、CompanyIdについては「And, You get CompanyId from Comapnies view.(そして、CompanyIdはCompaniesビューから取得します。)」と、freee Accountingとの接続が確立した後に取得可能なデーブル・ビューの方で確認するよう指示されているので、まずはCompanyId以外の情報を入力します。
8.[接続テスト]をクリックします。
9.表示される指示にしたがって必要な設定をすすめます。データソースによっては、このステップが生じない場合もあります。
(例)データソース=freee Accountingの場合
(1)Webブラウザが立ち上がり、アクセスの許可を実施します。
(2)下記のページが表示されたらWebブラウザを右上の「✕」などで閉じます。
10.メッセージ「接続テストに成功しました」が表示されたら[OK]をクリックします。
※なお、データソース=freee Accountingの場合、ここでCompanyIdの確認と入力を行います。
(1)タブ[データモデル]を開き、左側のテーブル・ビュー一覧から[Companies]を選択、タブ[クエリ]の[実行]をクリックすると、Companiesのデータが取得されますので、アクセスしたい事業所の[Id]を控えます。
(2)タブ[接続]を開き[ProfileSettings]に「CompanyId=」につづけて、(1)で確認したIdを入力します。
※[ProfileSettings]に複数のプロパティを入れる必要がある場合は「;(セミコロン)」で区切りながら入力してください。
(例)CompanyId=1234567;XXXXX=XXXXX;
(3)[接続テスト]をクリックし、メッセージ「接続テストに成功しました」が表示されたら[OK]をクリックします。
11.期待どおりデータが取得できるか確認します。タブ[データモデル]を開き、左側のテーブル・ビュー一覧から適当なテーブル・ビューを選択、タブ[クエリ]の[実行]をクリックして、データが取得されることを確認します。
(例)Banksのデータを取得
12.各[OK]クリックで[ODBC データソース アドミニストレータ―]を閉じます。
ツール・プログラム(プログラミング言語)からデータを取得する
13.利用するツール・プログラム(プログラミング言語)からODBCデータソースを呼出して、利用します。
(例)Accessの場合
(1)[新しいデータソース]>[他のソースから]>[ODBCデータベース]をクリックします。
(2)取得方法を選択し、[OK]をクリックします。
(3)「CData API Source」(あるいは、「CData API Sys」)を選択します(5で選択した方のデータソース名を選択してください)。
(4)データを取得したいテーブル・ビューを選択し、[OK]をクリックします。
(5)メッセージを確認し、[閉じる]をクリックします。
(6)あとはいつもの操作でデータを扱えます。
さいごに
API Driver for ODBCの基本の利用の流れは以上のとおりです。
特に手順の7や13のあたりは、接続したいデータソースの種類やツール、プログラミング言語により手順の詳細が異なる部分ですので、ご不明な場合はお気軽にお問い合わせフォームなどからおたずねください!