JDBI からYotpo データのデータアクセスオブジェクトを作成

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムYotpo のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Yotpo のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するYotpo のデータ の読み書きのためのコードの作成について説明します。

Yotpo ProductBottomLine Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyProductBottomLineDAO {
  //request specific data from Yotpo (String type is used for simplicity)
  @SqlQuery("SELECT AverageScore FROM ProductBottomLine WHERE ExternalProductId = :externalProductId")
  String findAverageScoreByExternalProductId(@Bind("externalProductId") String externalProductId);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Yotpo への接続を開く

必要な接続プロパティを収集し、Yotpo に接続するための適切なJDBC URL を作成します。

まず、Profile 接続プロパティをディスク上の Yotpo プロファイルの場所に設定します（例：C:\profiles\Yotpo.apip）。次に、ProfileSettings 接続プロパティを Yotpo の接続文字列に設定します（以下を参照）。

Yotpo API プロファイル設定

Yotpo への認証には、Yotpo の AppKey と AppSecret を使った OAuth 2.0 クライアントクレデンシャルフローを利用できます。

Yotpo API を使用するには、AppKey と AppSecret を持つ Yotpo ストアアカウントが必要です。これらの認証情報は、Yotpo ダッシュボードの「Account Settings」>「Store」で確認できます。

以下の接続プロパティを設定すると、接続できるようになります。

• AuthScheme：OAuthClient に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
• OAuthClientId：Yotpo の AppKey に設定します。
• OAuthClientSecret：Yotpo の AppSecret に設定します。

ビルトイン接続文字列デザイナー

JDBC URL の構成については、Yotpo JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.api.jar

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

Yotpo の接続文字列は、通常次のようになります。

jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;");
MyProductBottomLineDAO dao = dbi.open(MyProductBottomLineDAO.class);

//do stuff with the DAO

dao.close();

Yotpo データについて

Yotpo への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Yotpo のProductBottomLine エンティティからデータを取得できます。

//disply the result of our 'find' method
String averageScore = dao.findAverageScoreByExternalProductId("my-product-sku");
System.out.println(averageScore);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムYotpo を操作しましょう。