レガシーの拡張機能非推奨

この設定は、 拡張プログラムの設定ページの組み込みセクションで行います。

組み込みを開始するには、ボタンを切り替えて、OAuth を使用した Standard アカウントの登録を有効にします。拡張プログラムで Express アカウントの OAuth を使用することはできません。

Stripe provides a unique identifier for your extension called a client_id. You set the redirect_uri and users are directed to that page after they connect their accounts. You must specify all redirect URIs in your extension settings. The development and production versions of these two values help with testing. Take note of these values so you can create an OAuth link in the third step.

Extensions Settings (拡張プログラム設定)ページのブランディングセクションで、お客様のビジネスをユーザーに表示する形式をカスタマイズできます。

ユーザーが自身の Stripe アカウントをお客様のアプリケーションにリンクすると、お客様のロゴが表示されます。アカウントがリンクされると、接続されたアプリケーションのリストにお客様のアイコンが表示されます。

Stripe は、Stripe アカウントに接続するための標準の OAuth 2.0 フローを提供しています。ステップ 1 の client_id と redirect_uri の値を使用し、ユーザーがアカウント登録する OAuth リンクを作成できます。このリンクを、ユーザーを authorize_url エンドポイントに送るための Connect with Stripe (Stripe と連結) ボタンとともに表示することをお勧めします。

https://connect.stripe.com/oauth/authorize?response_type=code&client_id=ca_FkyHCg7X8mlvCUdMDao4mMxagUfhIwXb&scope=read_only

以下に、上記のリンクをユーザーに対して表示する方法例と、Connect with Stripe (Stripe と連結) ボタンを示します。

ユーザーがサイトのリンクをクリックすると、ユーザーは、お客様の拡張プログラムへの接続を許可または拒否できるページにリダイレクトされます。Stripe のオーソリフローにより、既存のアカウントを選択して拡張プログラムに接続するか、新しいアカウントを作成するように求められます。

ユーザーが既存または新規作成したアカウントを拡張プログラムに連結した後、ユーザーは再度お客様が拡張プログラムの redirect_uri として設定した URL にリダイレクトされます。

OAuth ワークフローの最後に、ユーザーのアカウントの認証情報が提供されます。

{
  ...
  "stripe_user_id": "acct_0123456789",
  ...
}

ユーザーアカウントを識別できるように、stripe_user_id を保存する必要があります。

ユーザーが Stripe アカウントをお客様のアプリケーションにリンクすると、ユーザーの代わりに API リクエストを実行できます。API リクエストを実行するには、自身の拡張プログラムアカウントのシークレットキーと、リクエスト対象のアカウントを識別する Stripe-Account ヘッダーが必要です。Stripe ライブラリーはすべて、リクエスト単位でこのスタイルの認証をサポートします。

保存されたデータを取得する

保存されたデータには、支払いや顧客の詳細などの情報が含まれます。read_only アクセスを使用すると、Stripe の API でほとんどの GET リクエストを実行できます。単一のオブジェクト (PaymentIntent (支払いインテント) の取得など) またはオブジェクトのリスト (すべての Payment Intent のリストなど) を取得できます。

curl https://api.stripe.com/v1/payment_intents \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "created[lte]"=1612048287 \
  -d "limit"=50 \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"

この API は高パフォーマンスを実現するように設計されていますが、大容量のデータを繰り返し取得するとアプリケーションの応答が遅くなります。分析やレポートには、取得したデータをお客様の側で保存することをお勧めします。

リアルタイムのデータをリッスンする

保存されたデータに加え、Webhook を使用することでリアルタイムのデータにもアクセスできます。アカウントで拡張プログラム Webhook エンドポイントを定義すると、Stripe は各連結アカウントについてのイベント通知をエンドポイントに送信します。このイベントオブジェクトの account プロパティは、イベントが発生したアカウントを示しています。

たとえば、以下のイベントは、acct_0123456789 アカウントで顧客が作成されたことを示しています。繰り返しますが、分析やレポートに備えてこのデータをお客様側で保存することをお勧めします。イベントの発生をリアルタイムで監視することにより、アプリケーションの反応をスピードアップできるだけでなく、多数の API コールを実行する必要もなくなります。

{
  "id": "evt_7JdhYdyssDgK4r",
  "livemode": true,
  "object": "event",
  "type": "customer.created",
  "account": "acct_0123456789",
  "pending_webhooks": 2,
  "created": 1349654313,
  "data": {...}
}