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

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

API Server の設定

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

Deel への接続

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

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

5. Deel への認証には、API キー（Bearer トークン）認証を使用できます。

   API キー認証の設定

   Deel の API キーを使って認証できます。Deel アカウント設定の Settings > API または Developer Settings で API キーを作成してください。アクセスするデータに応じて適切な権限を付与してください（例：請求書、タイムシート、契約、ワーカーなどへの読み取りアクセス）。

   API キーを作成したら、以下の接続プロパティを設定します：

   • AuthScheme：APIKey に設定します。
   • APIKey：Deel の API キー（Bearer トークン）に設定します。

   API キー接続文字列の例

   Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';
   

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

Deel への認証には、API キー（Bearer トークン）認証を使用できます。

API キー認証の設定

Deel の API キーを使って認証できます。Deel アカウント設定の Settings > API または Developer Settings で API キーを作成してください。アクセスするデータに応じて適切な権限を付与してください（例：請求書、タイムシート、契約、ワーカーなどへの読み取りアクセス）。

API キーを作成したら、以下の接続プロパティを設定します：

• AuthScheme：APIKey に設定します。
• APIKey：Deel の API キー（Bearer トークン）に設定します。

API キー接続文字列の例

Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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