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