Aqua Data Studio で freee人事労務 のデータ に接続
CData JDBC Driver for freee人事労務 は、Aqua Data Studio などの IDE のウィザードや分析機能と freee人事労務 のデータ を連携できます。本記事では、接続マネージャーを使って freee人事労務 のデータ に接続し、クエリを実行する方法を説明します。
JDBC データソースの作成
接続マネージャーを使用して接続プロパティを定義し、新しい JDBC データソースとして保存できます。作成した freee人事労務 データソースは、Aqua Data Studio の各ツールからアクセスできるようになります。
- Aqua Data Studio で、Servers メニューから Register Server を選択します。
- Register Server フォームで、「Generic - JDBC」接続を選択します。
- 以下の JDBC 接続プロパティを入力します:
- Name: データソースの名前を入力します(例:freee人事労務)。
- Driver Location: Browse ボタンをクリックし、インストールディレクトリの lib サブフォルダにある cdata.jdbc.api.jar ファイルを選択します。
- Driver: ドライバーのクラス名 cdata.jdbc.api.APIDriver を入力します。
URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後にセミコロン区切りで接続プロパティを指定します。
まずは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
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
一般的な JDBC URL は以下のとおりです:jdbc:api:Profile=freeehr.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
freee人事労務 のデータ へのクエリ
これで、公開されているテーブルにクエリを実行できます。