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

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

API Server の設定

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

ServiceDesk Plus への接続

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

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

5. OAuth 認証の設定

   ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

   1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
   2. アプリケーション構成に合わせてリダイレクト URI を設定します
   3. アプリケーション設定から Client ID と Client Secret を控えておきます

   以下の接続プロパティを設定して接続を確立してください：

   • AuthScheme：OAuth に設定します。
   • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
   • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
   • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
   • Domain：ServiceDeskPlus のドメインに設定します。
   • Portal：ServiceDeskPlus のポータルに設定します。

   接続文字列の例

   Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
   

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

OAuth 認証の設定

ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
2. アプリケーション構成に合わせてリダイレクト URI を設定します
3. アプリケーション設定から Client ID と Client Secret を控えておきます

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• OAuthClientId：Zoho アプリケーションの Client ID に設定します。
• OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
• Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
• Domain：ServiceDeskPlus のドメインに設定します。
• Portal：ServiceDeskPlus のポータルに設定します。

接続文字列の例

Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

API Server のユーザー設定

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

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

ServiceDesk Plus 用のAPI エンドポイントの作成

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

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

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

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

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

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

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

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