Node.js からFreshBooks のデータをクエリ
CData API Server とADO.NET Provider for API(もしくは240+ の他のADO.NET Providers)を使って、FreshBooks をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたFreshBooks のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなFreshBooks OData サービスを作成していきましょう。
FreshBooks への接続
NodeJS からFreshBooks のデータを操作するには、まずFreshBooks への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「FreshBooks」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、FreshBooks への接続設定を行っていきましょう！
-
まず、Profile 接続プロパティをディスク上の FreshBooks プロファイルの場所に設定します（例：C:\profiles\FreshBooks.apip）。次に、ProfileSettings 接続プロパティを FreshBooks の接続文字列に設定します（以下を参照）。
FreshBooks API プロファイル設定
FreshBooks Developer Dashboard で OAuth アプリケーションを登録し、Client ID と Client Secret を取得します。アプリケーションのコールバック URL にリダイレクト URI を設定します。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
FreshBooks に接続するには、クライアントアプリケーションを登録します。アプリの登録後、以下を設定します。
- OAuth Client Id: アプリに割り当てられた client_id。
- OAuth Client Secret: アプリに割り当てられた client_secret。
Sign In をクリックして OAuth 認証を完了します。
API Server のユーザー設定
次に、API Server 経由でFreshBooks にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
FreshBooks 用のAPI エンドポイントの作成
ユーザーを作成したら、FreshBooks のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でFreshBooks への接続を設定してユーザーを作成し、API Server でFreshBooks データのAPI を追加しました。これで、OData 形式のFreshBooks データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からFreshBooks OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはInvoices データに対して認証されたリクエストを行います。 以下のURL の例では、AccountId カラムの値がyour_account_id のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Invoices?$filter=" + encodeURIComponent("AccountId eq 'your_account_id'"),
auth:'MyUser:MyAuthtoken'
},
function(res) {
var body = '';
res.on('data', function(chunk) {
body += chunk;
});
res.on('end', function() {
console.log(body);
var jsonData = JSON.parse(body);
});
}).on('error', function(e) {
console.log("Error: ", e);
});