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

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

API Server の設定

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

Workable への接続

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

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

5. API キー認証の設定

   Workable は、API へのアクセスを制御するために API キー認証を使用します。API Key を取得するには、以下のステップで進めます：

   1. Workable アカウントにログインします。
   2. Settings > Integrations > API Access Tokens に移動します。
   3. 「Generate API Token」をクリックします。
   4. 生成されたトークンをコピーします。

   API Key を取得したら、以下の接続プロパティを設定します：

   • AuthScheme：APIKey に設定します。
   ProfileSettings 接続プロパティには以下を設定します：
   • APIKey：Workable の API Key に設定します。
   • Subdomain：Workable アカウントのサブドメインに設定します。たとえば、Workable の URL が acmeinc.workable.com の場合、Subdomain は 'acmeinc' になります。

   接続文字列の例

   Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
   

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

API キー認証の設定

Workable は、API へのアクセスを制御するために API キー認証を使用します。API Key を取得するには、以下のステップで進めます：

1. Workable アカウントにログインします。
2. Settings > Integrations > API Access Tokens に移動します。
3. 「Generate API Token」をクリックします。
4. 生成されたトークンをコピーします。

API Key を取得したら、以下の接続プロパティを設定します：

• AuthScheme：APIKey に設定します。

• APIKey：Workable の API Key に設定します。
• Subdomain：Workable アカウントのサブドメインに設定します。たとえば、Workable の URL が acmeinc.workable.com の場合、Subdomain は 'acmeinc' になります。

接続文字列の例

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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