JDBI からDeel データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムDeel のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Deel のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するDeel のデータ の読み書きのためのコードの作成について説明します。
Deel Invoices Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyInvoicesDAO {
//request specific data from Deel (String type is used for simplicity)
@SqlQuery("SELECT FROM Invoices WHERE = :")
String findBy(@Bind("") String );
/*
* close with no args is used to close the connection
*/
void close();
}
Deel への接続を開く
必要な接続プロパティを収集し、Deel に接続するための適切なJDBC URL を作成します。
Deel への認証には、API キー(Bearer トークン)認証を使用できます。
API キー認証の設定
Deel の API キーを使って認証できます。Deel アカウント設定の Settings > API または Developer Settings で API キーを作成してください。アクセスするデータに応じて適切な権限を付与してください(例:請求書、タイムシート、契約、ワーカーなどへの読み取りアクセス)。
API キーを作成したら、以下の接続プロパティを設定します:
- AuthScheme:APIKey に設定します。
- APIKey:Deel の API キー(Bearer トークン)に設定します。
API キー接続文字列の例
Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Deel JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Deel の接続文字列は、通常次のようになります。
jdbc:api:Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';");
MyInvoicesDAO dao = dbi.open(MyInvoicesDAO.class);
//do stuff with the DAO
dao.close();
Deel データについて
Deel への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Deel のInvoices エンティティからデータを取得できます。
//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 アプリケーションでリアルタイムDeel を操作しましょう。