Mule アプリケーションからBigCommerce のデータにアクセス：CData JDBC Driver

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for BigCommerce はBigCommerce のデータをMule アプリケーションと連携することで、読み、書き、更新、削除といった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、BigCommerce のデータをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。

本記事では、Mule プロジェクト内でCData JDBC Driver for BigCommerce を使用して、BigCommerce のデータのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でBigCommerce のデータをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで250 を超えるデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。

1. Anypoint Studio で新しいMule プロジェクトを作る。
2. Message Flow にHTTP コネクタを追加する。
3. HTTP コネクタのアドレスを設定する。
4. HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
5. データベースへの新しい接続を作成し（または既存の接続を編集し）、プロパティを設定する。
   • 接続を「Generic Connection」に設定
   • Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例：cdata.jdbc.bigcommerce.jar)。
   • BigCommerce の接続文字列にURL を指定

     BigCommerce 認証は標準のOAuth フローに基づいています。

     Store ID の取得

     BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

     1. BigCommerce アカウントにログインします。
     2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
     3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
     4. 画面にAPI Path という名前のテキストボックスが表示されます。
     5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
     6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
     7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

     パーソナルアクセストークンの取得

     加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

     1. BigCommerce アカウントにログインします。
     2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
     3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
     4. アカウント名を入力します。
     5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
     6. 「保存」をクリックします。

     BigCommerce への認証

     次に、以下を設定してデータに接続できます。
     • StoreId：API Path テキストボックスから取得したStore ID に設定。
     • OAuthAccessToken：生成したトークンに設定。
     • InitiateOAuth：OFF に設定。

     組み込みの接続文字列デザイナ

     JDBC 用のURL の作成にサポートが必要な場合は、BigCommerce JDBC Driver に組み込まれた接続文字列デザイナを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行してください。

     java -jar cdata.jdbc.bigcommerce.jar

     接続プロパティを入力して、接続文字列をクリップボードにコピーします。

   • Driver クラス名をcdata.jdbc.bigcommerce.BigCommerceDriver に指定します。
   • 「接続テスト」をクリックします。
6. SQL Query Text をBigCommerce のデータをリクエストするためのSQL クエリに設定します。例えば、SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'。
7. Transform Message コンポーネントをフローに追加します。
8. Output スクリプトを次のように設定して、ペイロードをJSON に変換します。

   %dw 2.0
   output application/json
   ---
   payload
           

9. BigCommerce のデータを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します（デフォルトでは、localhost:8081）：http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、BigCommerce のデータをJSON として利用できます。

これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからBigCommerce のデータを（JSON データとして）扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for BigCommerce の30日の無償評価版のダウンロードはこちらから。