Node.js からPaddle のデータをクエリ
CData API Server とADO.NET Provider for API(もしくは240+ の他のADO.NET Providers)を使って、Paddle をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたPaddle のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなPaddle OData サービスを作成していきましょう。
Paddle への接続
NodeJS からPaddle のデータを操作するには、まずPaddle への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Paddle」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Paddle への接続設定を行っていきましょう！
-
API キー認証の設定
Paddle は API キー認証を使用します。API キーを取得するには、以下のステップで進めます：
- https://vendors.paddle.com で Paddle アカウントにサインインします
- Developer Tools > Authentication に移動します
- 「Generate API Key」をクリックします
- アクセスしたいデータに対して適切な権限を割り当てます
- 生成されたキーをコピーします（サンドボックスキーは pdl_sdbx_apikey_ で始まり、本番キーは pdl_live_apikey_ で始まります）
API キーを取得したら、以下の接続プロパティを設定します：
- AuthScheme：APIKey に設定します。
- APIKey：Paddle の API キーに設定します。
接続文字列の例
Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
Paddle への接続
認証を設定すると、Paddle に接続して、Products、Customers、Subscriptions、Transactions などの利用可能なテーブルからデータをクエリできます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
Paddle は API キー認証を使用します。API キーを取得するには、以下のステップで進めます：
- https://vendors.paddle.com で Paddle アカウントにサインインします
- Developer Tools > Authentication に移動します
- 「Generate API Key」をクリックします
- アクセスしたいデータに対して適切な権限を割り当てます
- 生成されたキーをコピーします（サンドボックスキーは pdl_sdbx_apikey_ で始まり、本番キーは pdl_live_apikey_ で始まります）
API キーを取得したら、以下の接続プロパティを設定します：
- AuthScheme：APIKey に設定します。
- APIKey：Paddle の API キーに設定します。
接続文字列の例
Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
Paddle への接続
認証を設定すると、Paddle に接続して、Products、Customers、Subscriptions、Transactions などの利用可能なテーブルからデータをクエリできます。
API Server のユーザー設定
次に、API Server 経由でPaddle にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Paddle 用のAPI エンドポイントの作成
ユーザーを作成したら、Paddle のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でPaddle への接続を設定してユーザーを作成し、API Server でPaddle データのAPI を追加しました。これで、OData 形式のPaddle データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からPaddle OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはProducts データに対して認証されたリクエストを行います。 以下のURL の例では、 カラムの値が のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Products?$filter=" + encodeURIComponent(" eq ''"),
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);
});