各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からPipedrive データ のデータアクセスオブジェクトを作成
JDBI でPipedrive のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるPipedrive 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Pipedrive は、Java アプリケーションとリアルタイムPipedrive のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Pipedrive のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するPipedrive のデータ の読み書きのためのコードの作成について説明します。
Pipedrive Deals Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyDealsDAO {
//insert new data into Pipedrive
@SqlUpdate("INSERT INTO Deals (Value, UserEmail) values (:value, :userEmail)")
void insert(@Bind("value") String value, @Bind("userEmail") String userEmail);
//request specific data from Pipedrive (String type is used for simplicity)
@SqlQuery("SELECT UserEmail FROM Deals WHERE Value = :value")
String findUserEmailByValue(@Bind("value") String value);
/*
* close with no args is used to close the connection
*/
void close();
}
Pipedrive への接続を開く
必要な接続プロパティを収集し、Pipedrive に接続するための適切なJDBC URL を作成します。
Pipedrive 接続プロパティの取得・設定方法
Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。
Basic 認証
Basic 認証で認証するには：- API トークンを取得します。
- Pipedrive ポータルを開きます。
- ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
- 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
- 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
- 次の接続プロパティを設定します。
- APIToken：取得したAPI トークンの値。
- CompanyDomain：開発者サンドボックスURL のCompanyDomain。
- AuthScheme：Basic。
- 承認されたユーザー名とパスワードでログインします。
API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。
OAuth 認証
ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Pipedrive JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.pipedrive.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Pipedrive の接続文字列は、通常次のようになります。
jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;");
MyDealsDAO dao = dbi.open(MyDealsDAO.class);
//do stuff with the DAO
dao.close();
Pipedrive データ について
Pipedrive への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Pipedrive のDeals エンティティからデータを取得できます。
//disply the result of our 'find' method
String userEmail = dao.findUserEmailByValue("50000");
System.out.println(userEmail);
Pipedrive データ の書き方
以前定義した方法を使用すれば、Pipedrive にデータを書き込むことも簡単になります。
//add a new entry to the Deals entity
dao.insert(newValue, newUserEmail);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Pipedrive と統合することで、SQL Object API for Pipedrive を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムPipedrive を操作しましょう。
関連コンテンツ
