ColdFusion から freee HR のデータにクエリ

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
ColdFusion の標準データアクセスコードで freee HR のデータ に接続。

CData JDBC ドライバーを使用すると、ColdFusion の高速開発ツールを使って freee HR のデータ にシームレスに接続できます。本記事では、ColdFusion から freee HR のデータ に接続し、freee HR テーブルにクエリを実行する方法を説明します。

ColdFusion で freee HR 用JDBC データソースを作成

JDBC データソースを設定すると、cfquery タグや executeQuery などのCFScript から標準SQL を実行できるようになります。

  1. インストールディレクトリから、ドライバーのJAR ファイルと.lic ファイルをColdFusion のクラスパスにコピーします。例えば、C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib にコピーします。または、ColdFusion Administrator の[Java と JVM]ページで、[ColdFusion Class Path]ボックスにファイルへのパスを入力します。

    ドライバーのJAR ファイルとライセンスファイルは、インストールディレクトリの lib サブフォルダにあります。

    この手順の後、サーバーを再起動してください。

  2. ドライバーをデータソースとして追加します。

    ColdFusion Administrator 画面で、[データ&サービス]ノードを展開し、[データソース]をクリックします。[新しいデータソースの追加]セクションで、データソースの名前を入力し、[ドライバー]メニューから[Other]を選択します。

  3. ドライバーのプロパティを設定します。

    • JDBC URL:JDBC URL に接続プロパティを入力します。JDBC URL は jdbc:api: で始まり、その後にセミコロン区切りで name=value 形式の接続プロパティを指定します。

      まずは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 HR JDBC ドライバーに組み込まれた接続文字列デザイナーをご利用ください。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;
    • Driver Class:ドライバークラスを入力します。ドライバークラスは cdata.jdbc.api.APIDriver です。
    • Driver Name:ドライバーのユーザー定義名を入力します。
    • Username:認証に使用するユーザー名を入力します。
    • Password:認証に使用するパスワードを入力します。

これで、[操作]列で CData freee HR データソースを有効にして接続をテストできます。ステータスがOK と表示されたら、freee HR データソースの準備完了です。

クエリの実行

cfquery タグで freee HR にSQL ステートメントを送信できます。cfqueryparam タグを使用して、パラメータ化クエリを作成し、クエリ文字列によるSQL インジェクションを防止します。

注意cfquerycfscript を使用するには、.cfm ファイルを作成します。その.cfm ファイル内に、クエリを実行するコードを記述します(下記参照)。ファイルをWeb サーバーのルートディレクトリ(Adobe ColdFusion の場合はwwwroot など)に直接配置します。変更を反映するには、ファイル配置後にサービスを再起動してください。


<cfquery name="APIQuery" dataSource="CDataAPI">
  SELECT * FROM Employees WHERE Id = <cfqueryparam value="#Id#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#APIQuery#">

CFScript で記述すると以下のようになります。


<cfscript>
result = queryExecute(
  "SELECT * FROM Employees WHERE Id = ?",
  [
    { value="1", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAPI" }
);

writeDump( var= result );
</cfscript>

その後、以下のように.cfm ファイルにリクエストを送信できます。

http://MyServer:8500/query.cfm?Id=1

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

API Driver で freee HR のライブデータに接続

freee HR に接続