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

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

API Server の設定

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

Invoiced への接続

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

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

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

   Invoiced API プロファイル設定

   Invoiced に認証するには、API キーを提供する必要があります。API キーは、アカウントにサインインし、Settings > Developers > API Keys に移動して取得できます。ProfileSettings プロパティにAPI Key を設定して接続します。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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

Invoiced API プロファイル設定

Invoiced に認証するには、API キーを提供する必要があります。API キーは、アカウントにサインインし、Settings > Developers > API Keys に移動して取得できます。ProfileSettings プロパティにAPI Key を設定して接続します。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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