Node.js からSuiteCRM のデータをクエリ
CData API Server とADO.NET Provider for SuiteCRM(もしくは250+ の他のADO.NET Providers)を使って、SuiteCRM をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたSuiteCRM のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSuiteCRM OData サービスを作成していきましょう。
SuiteCRM への接続
NodeJS からSuiteCRM のデータを操作するには、まずSuiteCRM への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SuiteCRM」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、SuiteCRM への接続設定を行っていきましょう！
-
次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。
- Schema：suitecrmv4 に設定。
- Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
- User：SuiteCRM に紐づいているユーザーに設定。
- Password：SuiteCRM に紐づいているパスワードに設定。
SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。
- Schema：suitecrmv4 に設定。
- Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
- User：SuiteCRM に紐づいているユーザーに設定。
- Password：SuiteCRM に紐づいているパスワードに設定。
SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。
API Server のユーザー設定
次に、API Server 経由でSuiteCRM にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
SuiteCRM 用のAPI エンドポイントの作成
ユーザーを作成したら、SuiteCRM のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でSuiteCRM への接続を設定してユーザーを作成し、API Server でSuiteCRM データのAPI を追加しました。これで、OData 形式のSuiteCRM データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からSuiteCRM OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはAccounts データに対して認証されたリクエストを行います。 以下のURL の例では、Industry カラムの値がManufacturing のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Accounts?$filter=" + encodeURIComponent("Industry eq 'Manufacturing'"),
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);
});