ユースケース

ワークベンチには、開発者が Stripe システムのデバッグ、管理、拡張を行うためのツールが数多く用意されています。これらのガイドは、一般的な開発者の作業の方法を理解する上で役立ちます。

API リクエストで使用される API バージョンを表示する

Stripe にリクエストを送信するときに、Stripe-Version ヘッダーで API バージョンを指定できます。API バージョンを指定しない場合は、アカウントのデフォルトの API バージョンが使用されます。

1. ワークベンチの概要タブを開きます。
2. API バージョンセクションを調べて、先週のリクエストを確認します。
3. アカウントのデフォルトの API バージョンには、ラベル Default が表示されます。最新の API バージョンを使用して行われたリクエストには、ラベル Latest が表示されます。

バージョンのリストを確認するには、API の変更ログをご覧ください

最近の実装エラーを表示する

Stripe は、エラータイプとエンドポイントごとに最近の導入エラーをグループ化します。

1. ワークベンチのエラータブを開きます。
2. 最近のエラーペインで、エラーを絞り込む期間を選択します。
3. エラーのグループをクリックすると、発生回数、API エンドポイント、リクエストソースを説明する概要が表示されます。

HTTP メソッドまたはステータス別に API リクエストログを表示する

以下のステップを使用して、API リクエストログを HTTP メソッドまたはステータスで絞り込みます。

1. ワークベンチのログタブを開きます。
2. ステータスをクリックして、成功または失敗のリクエストをフィルタリングします。(Stripe が返す HTTP ステータスコードの完全なリストはこちらでご覧いただけます。)
3. 適用をクリックします。

ソース別に API リクエストログを表示する

次の手順に従い、ソースごとに API リクエストログをフィルター処理します。API リクエストは、ダッシュボードでの操作、または API コール (SDK の使用など) によって開始できます。

1. ワークベンチのログタブを開きます。
2. フィルターを追加をクリックします。
3. ソースで、ダッシュボードまたは API を選択して、リクエストをソースで絞り込みます。
4. 適用をクリックします。

リソース ID で絞り込む

Stripe API を使用して、Stripe リソースを作成、更新、または削除すると、レスポンスペイロードでリソース ID が返されます。たとえば、顧客を作成すると、cus_ImZZa3EEvvQQQU などの顧客 ID が (id フィールドに) 返されます。以下のステップを使用して、リソース ID で API リクエストを絞り込みます。

1. ワークベンチのログタブを開きます。
2. リソース ID でフィルターテキストフィールドにリソース ID を入力して、キーボードの Enter を押します。

イベントを絞り込む

以下の手順に従って、イベントと、そのイベントオブジェクトのペイロードを確認します。

1. ワークベンチのイベントタブを開きます。
2. イベントで絞り込むには、イベントタイプをクリックします。
   • イベント名を入力します。例: payment_intent.created。
   • ワイルドカード文字を含めてイベント名を入力します。例: payment_intent.*。
3. 適用をクリックします。

View errors for a workflow run

You can use Workbench to inspect a workflow run. Click a step in the workflow in the Dashboard to see details, or open it in Workbench for inspection. To learn more, see Set up a workflow.