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

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

API Server の設定

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

Talkdesk への接続

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

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

5. Talkdesk では OAuth 2.0 の Client Credentials グラントを使用します。ブラウザでの認可ステップやコールバック URL は必要ありません。

   以下の接続プロパティを設定します。

   • AccountName：Talkdesk アカウントの名前。
   • Region：Talkdesk インスタンスがデプロイされているリージョン。指定できる値は US（デフォルト）、EU、CA、AU、UK、FedRamp です。
   • OAuthClientId：カスタム OAuth アプリケーションの登録時に割り当てられた Client Id。
   • OAuthClientSecret：カスタム OAuth アプリケーションに割り当てられた Client Secret。

   カスタム OAuth アプリケーションの作成

   1. Talkdesk アカウントにログインし、ナビゲーションメニューから OAuth Clients を選択します。
   2. Create OAuth Client をクリックし、クライアントにわかりやすい名前を付けます。
   3. Grant Type を Client Credentials に設定します。
   4. Add scopes をクリックし、アクセスしたいデータに応じたスコープを選択します。
   5. Create をクリックし、Client Id と Client Secret をコピーします。

   接続時、ドライバーは Talkdesk にアクセストークンを自動でリクエストしてキャッシュし、有効期限が切れると更新します。アプリケーションで選択したスコープが、クエリ予定のビューに対応していることを確認してください。対応していない場合、トークンのリクエストが失敗することがあります。

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

Talkdesk では OAuth 2.0 の Client Credentials グラントを使用します。ブラウザでの認可ステップやコールバック URL は必要ありません。

以下の接続プロパティを設定します。

• AccountName：Talkdesk アカウントの名前。
• Region：Talkdesk インスタンスがデプロイされているリージョン。指定できる値は US（デフォルト）、EU、CA、AU、UK、FedRamp です。
• OAuthClientId：カスタム OAuth アプリケーションの登録時に割り当てられた Client Id。
• OAuthClientSecret：カスタム OAuth アプリケーションに割り当てられた Client Secret。

カスタム OAuth アプリケーションの作成

1. Talkdesk アカウントにログインし、ナビゲーションメニューから OAuth Clients を選択します。
2. Create OAuth Client をクリックし、クライアントにわかりやすい名前を付けます。
3. Grant Type を Client Credentials に設定します。
4. Add scopes をクリックし、アクセスしたいデータに応じたスコープを選択します。
5. Create をクリックし、Client Id と Client Secret をコピーします。

接続時、ドライバーは Talkdesk にアクセストークンを自動でリクエストしてキャッシュし、有効期限が切れると更新します。アプリケーションで選択したスコープが、クエリ予定のビューに対応していることを確認してください。対応していない場合、トークンのリクエストが失敗することがあります。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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