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

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

はじめに

---

API Server の設定

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

Salesforce への接続

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

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

5. Salesforce 接続プロパティの設定方法

   埋め込みOAuth（UI でのログイン）による接続設定

   それでは、Salesforce への接続について説明していきましょう。最も簡単な方法として、Salesforce にログインする際と同様にUI 上からログインするだけで接続設定が完了します（埋め込みOAuth）。この方法をご利用になる場合は、「Salesforce への接続」をクリックしてください。

   標準認証の設定

   埋め込みOAuth 以外の方法を利用する場合、以下の3つの認証方式をご利用いただけます。標準的な認証方式では、以下の情報が必要となります。

   • ユーザー名
   • パスワード
   • セキュリティトークン

   セキュリティトークンの取得方法については、セキュリティトークン取得手順をご確認ください。

   OAuth 認証の設定

   ユーザー名とパスワードによる認証がご利用いただけない（避けたい）場合は、OAuth 認証をお使いいただけます。

   SSO（シングルサインオン）の設定

   最後に、IDプロバイダー経由でのシングルサインオンをご利用になる場合は、以下のプロパティを設定してください。

   • SSOProperties
   • SSOLoginUrl
   • TokenUrl

   より詳細な設定手順については、ヘルプドキュメントの「はじめに」セクションをご確認ください。

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

Salesforce 接続プロパティの設定方法

埋め込みOAuth（UI でのログイン）による接続設定

それでは、Salesforce への接続について説明していきましょう。最も簡単な方法として、Salesforce にログインする際と同様にUI 上からログインするだけで接続設定が完了します（埋め込みOAuth）。この方法をご利用になる場合は、「Salesforce への接続」をクリックしてください。

標準認証の設定

埋め込みOAuth 以外の方法を利用する場合、以下の3つの認証方式をご利用いただけます。標準的な認証方式では、以下の情報が必要となります。

• ユーザー名
• パスワード
• セキュリティトークン

セキュリティトークンの取得方法については、セキュリティトークン取得手順をご確認ください。

OAuth 認証の設定

ユーザー名とパスワードによる認証がご利用いただけない（避けたい）場合は、OAuth 認証をお使いいただけます。

SSO（シングルサインオン）の設定

最後に、IDプロバイダー経由でのシングルサインオンをご利用になる場合は、以下のプロパティを設定してください。

• SSOProperties
• SSOLoginUrl
• TokenUrl

より詳細な設定手順については、ヘルプドキュメントの「はじめに」セクションをご確認ください。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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