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

詳細情報をご希望ですか?

製品について詳細情報や無償トライアルをご案内します:

CData API Server



API Server は、データを外部に公開します。CData API Server のOData エンドポイントを使って、Node.js からFreshdesk へのCRUD クエリを実行します。

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

API サーバーをセットアップ

以下のステップに従って、安全なFreshdesk OData サービスの作成を開始します。

デプロイ

API サーバーは独自のサーバーで実行されます。Windows では、スタンドアロンサーバーまたはIIS を使用して展開できます。Java サーブレットコンテナで、API Server WAR ファイルをドロップします。詳細とハウツーについては、ヘルプドキュメントを参照してください。

API Server は、Microsoft AzureAmazon EC2Heroku にも簡単にデプロイできます。

Freshdesk に接続

API サーバーとADO.NET Provider for Freshdesk を展開した後、[Settings]->[Connections]をクリックし、API サーバー管理コンソールで新しい接続を追加してFreshdesk に接続するために必要な認証値とその他の接続プロパティを指定します。

FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

  • Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
  • APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.

次に、[Settings]->[Resources]をクリックして、API サーバーへのアクセスを許可するFreshdesk エンティティを選択できます。

API サーバーユーザーを承認

作成するOData サービスを決定したら、[Settings]->[Users]をクリックしてユーザーを承認します。API サーバーは、認証トークンベースの認証を使用して主要な認証スキームをサポートします。IP アドレスに基づいてアクセスを制限することもできます。ローカルマシンを除くすべてのIP アドレスはデフォルトで制限されています。SSL を使用して、接続を認証及び暗号化することができます。

Node.js からFreshdesk OData フィードを消費

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

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

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