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

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

API Server の設定

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

Freshservice への接続

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

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

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

   Freshservice API プロファイル設定

   Freshservice 画面右上の Profile Settings から API キーを取得します。Domain はアカウント URL のサブドメインです。

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

Freshservice に接続するには、Freshservice アカウントの Profile Settings > API Key に移動して API キーを生成します。次に、以下を設定します。

• API Key: Freshservice アカウントで生成した API キー。
• Domain: Freshservice のサブドメイン（例: URL が acmeinc.freshservice.com の場合、Domain には "acmeinc" を設定）。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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