Node.js からConstantContact のデータをクエリ
CData API Server とADO.NET Provider for API(もしくは250+ の他のADO.NET Providers)を使って、ConstantContact をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたConstantContact のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなConstantContact OData サービスを作成していきましょう。
ConstantContact への接続
NodeJS からConstantContact のデータを操作するには、まずConstantContact への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「ConstantContact」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、ConstantContact への接続設定を行っていきましょう!
-
まず、Profile 接続プロパティをディスク上のConstantContact プロファイルの場所に設定します(例:C:\profiles\ConstantContact.apip)。次に、ProfileSettings 接続プロパティをプロファイルの接続文字列に設定します(以下を参照)。
ConstantContact API プロファイル設定
ConstantContact はOAuth ベースの認証を使用します。
まず、ConstantContact でOAuth アプリケーションを登録します。ConstantContact API ガイド(https://v3.developer.constantcontact.com/api_guide/index.html)の「MyApplications」>「New Application」から登録できます。OAuth アプリケーションにはclient id(API キー)が割り当てられ、client secret(シークレット)を生成できます。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
- CallbackURL:アプリ設定で指定したRedirect URI に設定します。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
まず、Profile 接続プロパティをディスク上のConstantContact プロファイルの場所に設定します(例:C:\profiles\ConstantContact.apip)。次に、ProfileSettings 接続プロパティをプロファイルの接続文字列に設定します(以下を参照)。
ConstantContact API プロファイル設定
ConstantContact はOAuth ベースの認証を使用します。
まず、ConstantContact でOAuth アプリケーションを登録します。ConstantContact API ガイド(https://v3.developer.constantcontact.com/api_guide/index.html)の「MyApplications」>「New Application」から登録できます。OAuth アプリケーションにはclient id(API キー)が割り当てられ、client secret(シークレット)を生成できます。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
- CallbackURL:アプリ設定で指定したRedirect URI に設定します。
API Server のユーザー設定
次に、API Server 経由でConstantContact にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
ConstantContact 用のAPI エンドポイントの作成
ユーザーを作成したら、ConstantContact のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でConstantContact への接続を設定してユーザーを作成し、API Server でConstantContact データのAPI を追加しました。これで、OData 形式のConstantContact データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からConstantContact OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはContacts データに対して認証されたリクエストを行います。 以下のURL の例では、CompanyName カラムの値がAcme, Inc. のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Contacts?$filter=" + encodeURIComponent("CompanyName eq 'Acme, Inc.'"),
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);
});