Node.js からPayPal のデータをクエリ
CData API Server とADO.NET Provider for PayPal(もしくは250+ の他のADO.NET Providers)を使って、PayPal をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたPayPal のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなPayPal OData サービスを作成していきましょう。
PayPal への接続
NodeJS からPayPal のデータを操作するには、まずPayPal への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「PayPal」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、PayPal への接続設定を行っていきましょう！
-
それでは、PayPal への接続について説明していきましょう。CData製品では、2つのPayPal API のテーブルに対応しています。これらのAPI は、それぞれ異なる認証方法を使用します。
- REST API はOAuth 標準を使用します。REST API で認証するには、AuthScheme をOAuth に設定し、OAuthClientId およびOAuthClientSecret プロパティを設定してください
- 非推奨：SOAP API は廃止予定です。より優れたリソースアクセスのため、REST API のご利用をお勧めします
必要なAPI 資格情報の取得方法については、ヘルプドキュメントの「はじめに」をご確認ください。
使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。
テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報をご利用いただけます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
それでは、PayPal への接続について説明していきましょう。CData製品では、2つのPayPal API のテーブルに対応しています。これらのAPI は、それぞれ異なる認証方法を使用します。
- REST API はOAuth 標準を使用します。REST API で認証するには、AuthScheme をOAuth に設定し、OAuthClientId およびOAuthClientSecret プロパティを設定してください
- 非推奨：SOAP API は廃止予定です。より優れたリソースアクセスのため、REST API のご利用をお勧めします
必要なAPI 資格情報の取得方法については、ヘルプドキュメントの「はじめに」をご確認ください。
使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。
テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報をご利用いただけます。
API Server のユーザー設定
次に、API Server 経由でPayPal にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
PayPal 用のAPI エンドポイントの作成
ユーザーを作成したら、PayPal のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でPayPal への接続を設定してユーザーを作成し、API Server でPayPal データのAPI を追加しました。これで、OData 形式のPayPal データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からPayPal OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはTransactions データに対して認証されたリクエストを行います。 以下のURL の例では、TransactionClass カラムの値がReceived のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Transactions?$filter=" + encodeURIComponent("TransactionClass eq 'Received'"),
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);
});