ワークベンチ

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

• 最近のシステムエラーの概要を確認します。
• API オブジェクト、リクエストログ、イベント、Webhook 配信を調べます。
• Webhook エンドポイントの設定を作成して管理します。
• 事前構築済みのコマンドライン環境を使用して API リクエストを実行するか、API Explorer を使用して構築します。

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

始める

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

1. ダッシュボードにサインインします。開発者メニューでワークベンチをクリックします。

2. Workbench ペイン上部のハンドルをドラッグしてサイズを再指定したり、最大化アイコン () をクリックして、全画面モードを終了したり開始できます。

3. 最小化アイコン () をクリックして、Workbench をページ下部のタスクバーに縮小したり、展開アイコン () をクリックしてペインを再度開きます。タスクバーでは API オブジェクトを素早く調べることができ、また重大な API エラーとイベントアクティビティーについて警告する通知トレイが含まれています。

4. Workbench のタスクバーを非表示にするには、縮小アイコン () をクリックし、ダッシュボードの右側のアイコンにタスクバーを最小化します。アイコンにカーソルを合わせると、通知トレイが表示されます。アイコンをクリックすると、再び全画面の Workbench ペインが開きます。

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

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

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

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

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

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

• API キーウィジェットには、アカウントの標準および制限付きのキーのリストが表示されます。管理をクリックして、API キーを作成または更新します。

• API バージョンウィジェットには、お客様のアカウントへの最近の API リクエストで指定された API バージョンの内訳が表示されます。アップグレードが可能をクリックして、Stripe アカウントのデフォルトの API バージョンをアップグレードします。

• API リクエストと Webhook のグラフは、アカウントの最近の API アクティビティを視覚化したものです。ドロップダウンから期間を選択して、その期間のグラフに更新します。

• 最近のエラーには、Stripe アカウントでの最近のエラーの概要が示されます。

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

最近のエラーを表示する

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

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

左側のペインには、エラータイプと個々のエラー数 (タイプ別) が表示されます。エラーグループを選択すると、エラーの詳細とシステムへの影響の詳細を確認できます。

• 発生数の数は、指定された期間中にこのエラーが発生した頻度を示しています。

• パスには、このエラーの原因となったリクエストで使用された API エンドポイントが示されます。

• ソースには、このエラーの原因となったリクエストで使用されたユーザーエージェントが示されます。

• ログセクションには、指定した API エラーのリクエストログがまとめられています。いずれかをクリックすると、リクエストタブに詳細が表示され、関連するリクエストログの詳細なビューが表示されます。Organizations のログを表示している場合、このセクションでは、各エラーが適用される組織内のアカウントを特定します。

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

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

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

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

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

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

サンドボックスでは、API Explorer で編集ボタンをクリックすると、Shell タブの API Explorer に API オブジェクトが事前入力されます。そこから API プロパティを更新してオブジェクトを変更できます。自動検査トグルがオンになっている場合、検査機能が自動的に更新され、ダッシュボードには現在表示できるオブジェクトが表示されます。

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

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

• リクエスト日
• HTTP ステータス (例: 200)
• HTTP メソッド (例: POST または DELETE)
• API エンドポイント (例: /v1/checkout/sessions)
• リクエストを作成した IP アドレス
• ソース (ダイレクト API リクエストまたはダッシュボード)
• リクエストが適用されたアカウント。Connect プラットフォームの連結アカウントや組織内のアカウントである可能性があります。
• API バージョン (例: 2020-08-27)
• エラーコード (例: resource_missing)
• エラータイプ (例: invalid_request_error)
• エラーパラメーター (例: line_items[*][price])

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

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

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

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

• イベント日
• 送信ステータス (送信済みまたは失敗)
• イベントタイプ (例: customer.subscription.created) によっては、ワイルドカード (例: customer.*) を使用することもできます。
• API リソース (例: cus_123)

イベントタブには、Stripe アカウントの最近のアクティビティーが表示されます。Stripe は Webhook エンドポイントにイベントを送信できます

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

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

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

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

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

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

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

1. 新しいエンドポイントの作成をクリックして、Stripe がイベントを送信する新しい Webhook エンドポイントを設定します。
2. エンドポイントが、お客様のアカウントまたはプラットフォーム内の連結アカウントのどちらでイベントを受信するかを選択します。
3. Stripe が Webhook イベントの生成に使用する API バージョンを選択します。
4. リッスンするイベントタイプを選択します。
5. 続行をクリックします。
6. エンドポイントタイプを選択し、続行をクリックします。
7. サーバーが Webhook エンドポイントをホストする HTTPS URL を指定します。
8. 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 は、Workbench から Stripe の API を試行するのに役立ちます