ワークベンチ

ワークベンチは、ダッシュボードのどこからでも、ブラウザーで Stripe の実装をデバッグ、管理、拡張するのに役立ついくつかの開発者ツールを提供します。たとえば、ワークベンチを使用して以下を実行できます。

• Review a summary of recent integration errors.
• Inspect API objects, request logs, events, and webhook deliveries.
• Create and manage your webhook endpoint configuration.
• Run API requests using the built-in command line environment, or build them with the API Explorer.

アイデアを共有する: ツールの上部にあるフィードバックを送るをクリックして、機能リクエスト、バグレポート、フィードバックを共有してワークベンチを改善します。

始める

ワークベンチを使用するには、Stripe アカウントが必要です。管理者または開発者の役割を持つユーザーのみが、ワークベンチのすべてのツールを利用できます。

1. ダッシュボードにサインインします。開発者メニューでワークベンチをクリックします。
2. ワークベンチペインの上部のハンドルをドラッグしてサイズを再指定したり、最大化アイコン () をクリックすることで、全画面モードを終了したり開始できます。
3. 最小化アイコン () をクリックして、ワークベンチをページ下部のタスクバーに縮小したり、展開アイコン () をクリックしてペインを再度開きます。タスクバーでは API オブジェクトをすぐに調べることができ、また重要な API エラーとイベントアクティビティーについて警告する通知トレイが含まれています。
4. ワークベンチのタスクバーを非表示にするには、縮小アイコン () をクリックし、ダッシュボードの右側のアイコンにタスクバーを最小化します。アイコンの上にマウスのカーソルを置くと、通知トレイが表示されます。アイコンをクリックすると、再び全画面のワークベンチペインが開きます。

ワークベンチの各タブには複数のツールが含まれています。各タブの機能と使用方法について、以下で詳細をご覧ください。

ワークベンチツールを使用する

ワークベンチを使用する際は、次のツールを覚えておいてください。

• リンクをコピーをクリックして、現在のワークベンチビューの共有可能な URL を生成します。
• フィードバックを送信をクリックして、コア開発チームとアイデアや質問を共有します。

構築した Stripe システムの概要

概要タブで、アカウントの API アクティビティーの概要を確認します。

• API キーウィジェットには、アカウントの標準および制限付きのキーのリストが表示されます。管理をクリックして、API キーを作成または更新します。
• API バージョンウィジェットには、お客様のアカウントへの最近の API リクエストで指定された API バージョンの内訳が表示されます。アップグレードが可能をクリックして、Stripe アカウントのデフォルト API バージョンをアップグレードします。
• The API requests and Webhooks graphs visualize recent API activity on your account. Choose a time period from the dropdown to update the graphs for that interval.
• 最近のエラーには、Stripe アカウントでの最近のエラーの概要が示されます。

概要タブには、アカウントの API アクティビティーのスナップショットが表示されます。

最近のエラーを表示する

エラータブには、Stripe アカウントに対する最近のエラーがまとめられています。各タイプの API エラーの解消方法を参照し、各エラーへの最近の API リクエストログを確認できます。ドロップダウンから期間を選択して、その期間中のエラーを確認できます。

エラータブには、最近の API エラーがまとめられ、関連するリクエストログが示されています。

The left-hand pane shows error types and the number of individual errors per type. Select an error group to learn more about the error’s details and impact on your integration.

• 発生数の数は、指定された期間中にこのエラーが発生した頻度を示しています。
• パスには、このエラーの原因となったリクエストで使用された API エンドポイントが示されます。
• ソースには、このエラーの原因となったリクエストで使用されたユーザーエージェントが示されます。
• The Logs section summarizes requests logs for the specified API errors. Clicking on one reveals more details in the Requests tab, which provides a complete and detailed view of relevant request logs.

Inspector を使用して API オブジェクトについて把握する

検査機能を使用して、Stripe アカウントに含まれる API オブジェクトの JSON ビューの詳細を確認します。オブジェクトを調査するには、次の手順を実行します。

• 検査機能タブで、オブジェクト ID を入力します。
• 任意のオブジェクト (たとえば、Payment、Customer、Subscription) のダッシュボードに移動して、検査機能アイコン () をクリックするか、ワークベンチの検査機能タブを開きます。

検査機能には、API オブジェクトの JSON ビューと、関連する API オブジェクト、リクエストログ、イベントが表示されます。

API オブジェクトを検査する際、検査機能によって詳細が表示されます。

• 左側のペインには、関連する API オブジェクトの階層を示すデータマップが表示されます。
• 概要タブには、オブジェクトの JSON ビューが表示されます。
• ログタブには、オブジェクトに関連するリクエストログが表示されます。
• イベントタブでは、最近生成されたオブジェクト関連のイベントがまとめられています。

When in a sandbox, the Edit in API Explorer button pre-fills the API object into the API Explorer on the Shell tab. From there, you can update API properties to modify the object.

自動検査トグルが有効になっている場合、検査機能は自動的に更新されて、ダッシュボードを表示すると、現在表示できるオブジェクトが表示されます。

API リクエストログを表示する

ログタブには、Stripe アカウントでの最近の API リクエストとレスポンスが含まれています。ワークベンチには、最近のエラーとその解決方法に関する推奨事項がまとめられています。以下で API リクエストを絞り込むことができます。

• リクエスト日
• HTTP ステータス (例: 200)
• HTTP メソッド (例: POST または DELETE)
• API エンドポイント (例: /v1/checkout/sessions)
• リクエストを作成した IP アドレス
• ソース (ダイレクト API リクエストまたはダッシュボード)
• Account (or specifically when using Connect, the platform or connected accounts)
• API バージョン (例: 2020-08-27)
• エラーコード (例: resource_missing)
• エラータイプ (例: invalid_request_error)
• エラーパラメーター (例: line_items[*][price])

ワークベンチは、アカウントが新しい API リクエストを受信したときに、リアルタイムではこのタブを自動更新しません。ログを更新するをクリックして、Stripe アカウントから最新のリクエストログを取得します。

ログツールは、API アクティビティーのタイムラインを、タイムエンドポイント、レスポンスコード、その他のプロパティによるフィルター付きで表示します。

Stripe アカウントの最近のイベントを確認する

イベントタブには、Stripe アカウントでの最近のイベントのリストが含まれています。イベントを更新するをクリックして、Stripe アカウントから最新のイベントを取得します。以下の項目でイベントを絞り込むことができます。

• イベント日
• 送信ステータス (送信済みまたは失敗)
• Event type (for example, customer.subscription.created); you can also use wildcards (for example, customer.*)
• API リソース (例: cus_123)

The Events tab shows recent activity on your Stripe account. Stripe can deliver events to webhook endpoints.

左側のリストからイベントをクリックして、右側でイベントの詳細、ペイロード、試行された送信を確認します。

• 成功または失敗タブを選択して、配信の試行を特定のイベントで絞り込みます。
• オーバーフローメニュー () で、Webhook エンドポイントを表示をクリックして、このイベントの送信先を確認します。
• 配信の試行で再送するをクリックして、そのイベントを Webhook エンドポイントに再送します。

ワークベンチで Webhook エンドポイントを管理する方法をご覧ください。

Webhook エンドポイントを管理する

Webhook タブで、Stripe がイベントを送信する新しい Webhook エンドポイントを作成できます。

• Webhook を使用する URL エンドポイント
• Stripe CLI を使用するローカルマシン

新しいエンドポイントを作成する

1. Click Create new endpoint to configure a new webhook endpoint that Stripe sends events to.
2. Select the API version that Stripe uses to generate webhook events.
3. Choose which event types to listen for.
4. Click Continue.
5. Choose the type of endpoint and click Continue.
6. Provide an HTTPS URL where your server hosts the webhook endpoint.
7. Click Create webhook .

ワークベンチの左側には、設定済みの Webhook エンドポイントが一覧表示されます。概要には、その設定済みのエンドポイントでのアクティビティーがまとめられ、イベントの送信先には Stripe からそのエンドポイントへのイベント送信の試行の一覧が表示されます。送信の試行の横にある今すぐ再試行をクリックすると、Stripe はそのエンドポイントにイベントを再送信できます。

新しい Webhook エンドポイントを設定するか、イベントをローカル開発マシンに振り分けます。

シェルと Explorer を使用して API コマンドを実行する

Shell はワークベンチ内で Stripe のリソースを管理するための、Stripe CLI に似たコマンドラインインターフェイスを提供します。利用可能なコマンドの一覧については、Shell と API Explorer をご覧ください。

ワークベンチの使用時に、いつでも最小化された Shell をペインで利用できますが、Shell タブを使用して全画面のセッションを起動することもできます。Shell タブで新しいペインをクリックして、複数のシェルセッションにペインを分割します。

API Explorer をクリックすると、インタラクティブなコマンドビルダーが右側に表示されます。API リソースと HTTP メソッドを選択して、対象のリクエストの必須とオプションのパラメーターを表示します。ヘッダータブでは、連結アカウントへの API リクエストを実行できるようにする Stripe-Account ヘッダーなど、いくつかの HTTP ヘッダーを設定できます。実行をクリックして、API リクエストを実行します。

API Explorer にパラメーターを入力すると、対応する Shell コマンドが自動的に構築されます。プログラミング言語を選択して、SDK リクエストを出力するをクリックし、API リクエストに対応する SDK コードを確認します。

Shell と API Explorer は、ワークベンチから Stripe の API を試行するのに役立ちます。