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

加藤龍彦
加藤龍彦
デジタルマーケティング
JDBI でReply.io のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。

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

Reply.io BillingInfo Entity のDAO を作成

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

public interface MyBillingInfoDAO {
  //request specific data from Reply.io (String type is used for simplicity)
  @SqlQuery("SELECT  FROM BillingInfo WHERE  = :")
  String findBy(@Bind("") String );

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

Reply.io への接続を開く

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

Reply.io API は、x-api-key リクエストヘッダーを介した API キー認証を使用します。

API キー認証の設定

接続を作成するには、Reply.io の API キーが必要です。API キーを取得するには、以下のステップで進めます:

  1. Reply.io アカウントにログインします。
  2. プロフィールアイコンをクリックして Settings を選択します。
  3. API セクションに移動します。
  4. API キーをコピーします。

API キーを取得したら、以下の接続プロパティを設定します:

  • AuthScheme:APIKey に設定します。
  • APIKey:Reply.io の API キーに設定します。
  • UserEmail(オプション):リクエストを代理で行う Reply.io ユーザーのメールアドレスに設定します。

接続文字列の例:

Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

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

java -jar cdata.jdbc.api.jar

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

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:api:Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';");
MyBillingInfoDAO dao = dbi.open(MyBillingInfoDAO.class);

//do stuff with the DAO

dao.close();

Reply.io データについて

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

//disply the result of our 'find' method
String  = dao.findBy("");
System.out.println();

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

はじめる準備はできましたか?

API Driver で Reply.io のライブデータに接続

Reply.io に接続