Node.js からADP のデータをクエリ
CData API Server とADO.NET Provider for ADP(もしくは250+ の他のADO.NET Providers)を使って、ADP をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたADP のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなADP OData サービスを作成していきましょう。
ADP への接続
NodeJS からADP のデータを操作するには、まずADP への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「ADP」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、ADP への接続設定を行っていきましょう！
-
ADP 接続プロパティの取得・設定方法
接続を確立する前に、ADP に連絡してOAuth アプリとそれに関連するクレデンシャルを提供してもらう必要があります。 これらのクレデンシャルはADP からのみ取得が可能で、直接取得することはできません。
ADP への接続
次のプロパティを指定してADP に接続します。
- OAuthClientId：ADP より提供されたアプリのクライアントId に設定。
- OAuthClientSecret：ADP より提供されたアプリのクライアントシークレットに設定。
- SSLClientCert：ADP より提供された証明書に設定。
- SSLClientCertPassword：証明書のパスワードに設定。
- UseUAT：CData 製品はデフォルトで、本番環境にリクエストを行います。開発者アカウントを使用している場合は、UseUAT をtrue に設定します。
- RowScanDepth：テーブルで利用可能なカスタムフィールドカラムをスキャンする行数の最大値。デフォルト値は100に設定されています。大きい値を設定すると、パフォーマンスが低下する場合があります。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
ADP 接続プロパティの取得・設定方法
接続を確立する前に、ADP に連絡してOAuth アプリとそれに関連するクレデンシャルを提供してもらう必要があります。 これらのクレデンシャルはADP からのみ取得が可能で、直接取得することはできません。
ADP への接続
次のプロパティを指定してADP に接続します。
- OAuthClientId：ADP より提供されたアプリのクライアントId に設定。
- OAuthClientSecret：ADP より提供されたアプリのクライアントシークレットに設定。
- SSLClientCert：ADP より提供された証明書に設定。
- SSLClientCertPassword：証明書のパスワードに設定。
- UseUAT：CData 製品はデフォルトで、本番環境にリクエストを行います。開発者アカウントを使用している場合は、UseUAT をtrue に設定します。
- RowScanDepth：テーブルで利用可能なカスタムフィールドカラムをスキャンする行数の最大値。デフォルト値は100に設定されています。大きい値を設定すると、パフォーマンスが低下する場合があります。
API Server のユーザー設定
次に、API Server 経由でADP にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
ADP 用のAPI エンドポイントの作成
ユーザーを作成したら、ADP のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でADP への接続を設定してユーザーを作成し、API Server でADP データのAPI を追加しました。これで、OData 形式のADP データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からADP OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはWorkers データに対して認証されたリクエストを行います。 以下のURL の例では、AssociateOID カラムの値がG3349PZGBADQY8H8 のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Workers?$filter=" + encodeURIComponent("AssociateOID eq 'G3349PZGBADQY8H8'"),
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);
});