各製品の資料を入手。
詳細はこちら →JDBI からBigCommerce データ のデータアクセスオブジェクトを作成
JDBI でBigCommerce のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日:2022-05-25
この記事で実現できるBigCommerce 連携のシナリオ
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for BigCommerce は、Java アプリケーションとリアルタイムBigCommerce のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、BigCommerce のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するBigCommerce のデータ の読み書きのためのコードの作成について説明します。
BigCommerce Customers Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyCustomersDAO {
//insert new data into BigCommerce
@SqlUpdate("INSERT INTO Customers (FirstName, LastName) values (:firstName, :lastName)")
void insert(@Bind("firstName") String firstName, @Bind("lastName") String lastName);
//request specific data from BigCommerce (String type is used for simplicity)
@SqlQuery("SELECT LastName FROM Customers WHERE FirstName = :firstName")
String findLastNameByFirstName(@Bind("firstName") String firstName);
/*
* close with no args is used to close the connection
*/
void close();
}
BigCommerce への接続を開く
必要な接続プロパティを収集し、BigCommerce に接続するための適切なJDBC URL を作成します。
BigCommerce 認証は標準のOAuth フローに基づいています。
Store ID の取得
BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。
- BigCommerce アカウントにログインします。
- ホームページから「Advanced Settings」->「API Accounts」 を選択します。
- 「Create API Account」->「Create V2/V3 API Token」をクリックします。
- 画面にAPI Path という名前のテキストボックスが表示されます。
- テキストボックス内に、次の構造のURL が表示されます:https://api.bigcommerce.com/stores/{Store Id}/v3。
- 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
- Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。
パーソナルアクセストークンの取得
加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。
- BigCommerce アカウントにログインします。
- ホームページから「Advanced Settings」->「API Accounts」 を選択します。
- 「Create API Account」->「Create V2/V3 API Token」をクリックします。
- アカウント名を入力します。
- 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
- 「保存」をクリックします。
BigCommerce への認証
次に、以下を設定してデータに接続できます。- StoreId:API Path テキストボックスから取得したStore ID に設定。
- OAuthAccessToken:生成したトークンに設定。
- InitiateOAuth:OFF に設定。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、BigCommerce JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.bigcommerce.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

BigCommerce の接続文字列は、通常次のようになります。
jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH");
MyCustomersDAO dao = dbi.open(MyCustomersDAO.class);
//do stuff with the DAO
dao.close();
BigCommerce データ について
BigCommerce への接続を開いた状態で以前定義したメソッドを呼び出すだけで、BigCommerce のCustomers エンティティからデータを取得できます。
//disply the result of our 'find' method
String lastName = dao.findLastNameByFirstName("Bob");
System.out.println(lastName);
BigCommerce データ の書き方
以前定義した方法を使用すれば、BigCommerce にデータを書き込むことも簡単になります。
//add a new entry to the Customers entity
dao.insert(newFirstName, newLastName);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for BigCommerce と統合することで、SQL Object API for BigCommerce を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムBigCommerce を操作しましょう。