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

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

API Server の設定

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

Gong への接続

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

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

5. Gong への認証では、Gong の API Key と API Secret を使った API キー認証を利用できます。

   認証

   Gong への認証では、Gong の API Key と API Secret、およびテナントの Domain を指定する必要があります。これらの認証情報は結合され、Base64 エンコードされて、すべての API リクエストで使われる Basic 認証ヘッダーを形成します。

   API キー認証の設定

   API キーで認証するには、Gong のアカウント設定から API Key と API Secret を取得します。

   取得したら、AuthScheme を APIKey に設定し、認証情報を指定して接続します：

   • AuthScheme：APIKey に設定します。
   • APIKey：Gong の API Key に設定します。
   • APISecret：Gong の API Secret に設定します。
   • Domain：Gong のテナントドメインに設定します（例：us-36533.api.gong.io）。

   接続文字列の例

   Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';
   

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

Gong への認証では、Gong の API Key と API Secret を使った API キー認証を利用できます。

認証

Gong への認証では、Gong の API Key と API Secret、およびテナントの Domain を指定する必要があります。これらの認証情報は結合され、Base64 エンコードされて、すべての API リクエストで使われる Basic 認証ヘッダーを形成します。

API キー認証の設定

API キーで認証するには、Gong のアカウント設定から API Key と API Secret を取得します。

取得したら、AuthScheme を APIKey に設定し、認証情報を指定して接続します：

• AuthScheme：APIKey に設定します。
• APIKey：Gong の API Key に設定します。
• APISecret：Gong の API Secret に設定します。
• Domain：Gong のテナントドメインに設定します（例：us-36533.api.gong.io）。

接続文字列の例

Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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