各製品の資料を入手。
詳細はこちら →
JDBI からfreee データ のデータアクセスオブジェクトを作成
JDBI でfreee のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるfreee 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムfreee のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、freee のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するfreee のデータ の読み書きのためのコードの作成について説明します。
freee Deals Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyDealsDAO {
//request specific data from freee (String type is used for simplicity)
@SqlQuery("SELECT IssueDate FROM Deals WHERE Id = :id")
String findIssueDateById(@Bind("id") String id);
/*
* close with no args is used to close the connection
*/
void close();
}
freee への接続を開く
必要な接続プロパティを収集し、freee に接続するための適切なJDBC URL を作成します。
まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。
- AuthScheme：OAuth に設定します。
- OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
- OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
- CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、freee JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
freee の接続文字列は、通常次のようになります。
jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH");
MyDealsDAO dao = dbi.open(MyDealsDAO.class);
//do stuff with the DAO
dao.close();
freee データ について
freee への接続を開いた状態で以前定義したメソッドを呼び出すだけで、freee のDeals エンティティからデータを取得できます。
//disply the result of our 'find' method
String issueDate = dao.findIssueDateById("1");
System.out.println(issueDate);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムfreee を操作しましょう。
関連コンテンツ
