Node.js からClio のデータをクエリ

CData API Server とADO.NET Provider for API(もしくは250+ の他のADO.NET Providers)を使って、Clio をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたClio のデータをNode.js でリクエストする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなClio OData サービスを作成していきましょう。

Clio への接続

NodeJS からClio のデータを操作するには、まずClio への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Clio」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Clio への接続設定を行っていきましょう！

5. まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。

   Clio API プロファイル設定

   Clio はOAuth ベースの認証を使用します。

   まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

   以下の接続プロパティを設定すると、接続できるようになります。

   • AuthScheme：OAuth に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
   • OAuthClientId：アプリ設定で指定されたclient_id に設定します。
   • OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
   • CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
   • Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。

Clio API プロファイル設定

Clio はOAuth ベースの認証を使用します。

まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

以下の接続プロパティを設定すると、接続できるようになります。

• AuthScheme：OAuth に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
• OAuthClientId：アプリ設定で指定されたclient_id に設定します。
• OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
• CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
• Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。

API Server のユーザー設定

次に、API Server 経由でClio にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Clio 用のAPI エンドポイントの作成

ユーザーを作成したら、Clio のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でClio への接続を設定してユーザーを作成し、API Server でClio データのAPI を追加しました。これで、OData 形式のClio データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Node.js からClio OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはBills データに対して認証されたリクエストを行います。 以下のURL の例では、State カラムの値がawaiting_payment のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Bills?$filter=" + encodeURIComponent("State eq 'awaiting_payment'"),
  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);
});