ColdFusion でfreee データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for API は、ColdFusion のrapid development tools を使ってfreee への接続をシームレスに統合します。この記事では、ColdFusion でfreee に連携しfreee テーブルをクエリする方法を説明します。

ColdFusion にfreee のJDBC データソースを作成

下記の手順に従ってfreee データソースを作成し、ColdFusion アプリケーションへの連携を可能にします。

1. ドライバーのJAR および.lic ファイルを、インストールディレクトリから C:\ColdFusion10\cfusion\wwwroot\WEB-INF\lib にコピーします。

   ドライバーのJAR およびlicense はインストールディレクトリの［lib］サブフォルダに配置されています。

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

   ColdFusion Administrator インターフェースで［Data & Services］ノードを展開し、［Data Sources］>［Add New Data Source］をクリックします。ダイアログが表示されたら、以下のプロパティを入力します。

   • Data Source Name：データソースの名前を入力。名前はColdFusion 変数命名規則に一致する必要があります。
   • Driver：［Other］を選択。

3. JDBC Driver のプロパティ設定:

   • JDBC URL：JDBC URL に接続プロパティを入力。JDBC のURL は以下で始まり jdbc:api: 次に、セミコロン区切りでname=value ペアの接続プロパティを入力します。以下は一般的なJDBC URL です：

     jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_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 を取得するプロセスを管理できます。
   • Driver Class：ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.api.APIDriver
   • Driver Name：ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
   • Username：認証するユーザーネームを入力。
   • Password：認証するパスワードを入力。

［Actions］ カラムのCData freee データソースを有効にして、接続をテストできます。ステータスがOK になったら、freee データソースを使うことができます。

クエリを実行

下記の手順に従って、freee の基準に合ったレコードをクエリし、結果をHTML テーブルに出力する簡単なアプリケーションを作成します。

1. 新規ColdFusion markup ファイルでクエリを定義：C:\ColdFusion10\cfusion\wwwroot directory for ColdFusion の.cfm ファイルに次のコードを入力：

   <cfquery name="APIQuery" dataSource="CDataAPI"> SELECT * FROM Deals </cfquery>

   Note：CData JDBC Drivers は、cfqueryparam エレメントを使ってパラメータ化されたクエリもサポートします。例：

   <cfquery name="APIQuery" dataSource="CDataAPI"> SELECT * FROM Deals WHERE Id = <cfqueryparam>1</cfqueryparam> </cfquery>

2. CFTable を使ってHTML にテーブルを出力：

   <cftable query = "APIQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"/> <cfcol header="<b>Amount</b>" align="Left" width=6 text="#Amount#"></cfcol> <cfcol header="<b>IssueDate</b>" align="Left" width=9 text="#IssueDate#"></cfcol> </cftable>

3. コードを実行してグリッドを表示します。

HTML 部分を含む以下のフルコードが利用できます。