ワークベンチベータ
ベータ
To enable or disable Workbench, configure the setting for your user login from the Early access features in the Dashboard.
ワークベンチは、ダッシュボードのどこからでも、ブラウザーで Stripe の実装を構築、維持、デバッグするのに役立ついくつかの開発者ツールを提供します。たとえば、ワークベンチを使用して以下を実行できます。
- 最近の実装エラーのサマリーを確認する
- API オブジェクト、リクエストログ、イベント、Webhook の配信を調査する
- 構築済みのコマンドライン環境を使用して API リクエストを実行するか、API Explorer で構築する
- Webhook エンドポイントの設定を作成して管理する
アイデアを共有する: ツールの上部にあるフィードバックを送るをクリックして、機能リクエスト、バグレポート、フィードバックを共有してワークベンチを改善します。
始める
ワークベンチを使用するには、Stripe アカウントが必要であり、またダッシュボードの早期アクセス機能でベータを有効にする必要があります。管理者または開発者の役割を持つユーザーのみが、ワークベンチのすべてのツールを利用できます。
- ダッシュボードにサインインします。開発者メニューでワークベンチをクリックします。
- ワークベンチペインの上部のハンドルをドラッグしてサイズを再指定したり、最大化アイコン () をクリックすることで、全画面モードを終了したり開始できます。
- 最小化アイコン () をクリックして、ワークベンチをページ下部のタスクバーに縮小したり、展開アイコン () をクリックしてペインを再度開きます。タスクバーでは API オブジェクトをすぐに調べることができ、また重要な API エラーとイベントアクティビティーについて警告する通知トレイが含まれています。
- ワークベンチのタスクバーを非表示にするには、縮小アイコン () をクリックし、ダッシュボードの右側のアイコンにタスクバーを最小化します。アイコンの上にマウスのカーソルを置くと、通知トレイが表示されます。アイコンをクリックすると、再び全画面のワークベンチペインが開きます。
ワークベンチの各タブには複数のツールが含まれています。各タブの機能と使用方法について、以下で詳細をご覧ください。
注
ダッシュボードのどこからでも、キーボードのチルダキー (~) を押してワークベンチを開いたり最小化できます。
ワークベンチツールを使用する
ワークベンチを使用する際は、次のツールを覚えておいてください。
- リンクをコピーをクリックして、現在のワークベンチビューの共有可能な URL を生成します。
- フィードバックを送信をクリックして、コア開発チームとアイデアや質問を共有します。
構築済みの Stripe システムの概要
概要タブで、アカウントの API アクティビティーの概要を確認します。
- 構築済みのシステムのステータスウィジェットには、Stripe のインフラにおける既知のサービス低下が表示されます。
- API キーウィジェットには、アカウントの標準および制限付きのキーのリストが表示されます。管理をクリックして、API キーを作成または更新します。
- API バージョンウィジェットには、お客様のアカウントへの最近の API リクエストで使用された API バージョンの内訳が表示されます。アップグレードが可能をクリックして、Stripe アカウントのデフォルト API バージョンをアップグレードします。
- API リクエストと Webhook グラフは、アカウントでの最近の API アクティビティーを視覚化します。
- 実装内容に関するインサイトは、エラーを解決し、パフォーマンスを向上し、Stripe API をより適切に使用するために Stripe アカウントに対して実行できる、対応可能な改善点を表示します。
概要タブには、アカウントの API アクティビティーのスナップショットが表示されます。
最近のエラーを表示する
エラータブには、Stripe アカウントに対する最近のエラーがまとめられています。各タイプの API エラーの解消方法を参照し、各エラーへの最近の API リクエストログを確認できます。
エラータブには、最近の API エラーがまとめられ、関連するリクエストログが示されています。
検査機能を使用して API オブジェクトについて知る
検査機能を使用して、Stripe アカウントに含まれる API オブジェクトの JSON ビューの詳細を確認します。オブジェクトを調査するには、次の手順を実行します。
- 検査機能タブで、オブジェクト ID を入力します。
- ワークベンチのタスクバーで、オブジェクト ID を入力します。
- 任意のオブジェクト (たとえば、
Payment
、Customer
、Subscription
) のダッシュボードページに移動して、検査機能タブを開きます。
検査機能には、API オブジェクトの JSON ビューと、関連するリクエストログおよびイベントが表示されます。
検査機能タブでは、左側に関連するすべての API オブジェクトが表示され、概要タブに JSON ビューが表示されます。ログとイベントの各タブには、このオブジェクトへの関連する 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
)
左側のリストからイベントをクリックして、右側でイベントの詳細、ペイロード、試行された送信を確認します。ワークベンチでの Webhook エンドポイントの設定について、詳細をご覧ください。
イベントタブには Stripe アカウントの最近のアクティビティーが表示されます。イベントは Webhook に送信できます。
配信の試行セクションには、試行されたイベントの配信 (Webhook エンドポイントなど) が一覧表示されます。最初の試行が失敗した場合、ワークベンチには複数の配信の試行が表示される場合があります。Stripe は本番環境での送信を、複数回自動的に再試行します。今すぐ再試行をクリックして、イベントの再配信を手動で試行します。
Webhook エンドポイントを設定する
Webhook タブを使用すると、Stripe がイベントを送信する新しい Webhook エンドポイントを作成できます。
- Webhook を使用する URL エンドポイント
- Stripe CLI を使用するローカルマシン
新しいエンドポイントを作成するをクリックして、Stripe がイベントを送信する新しい Webhook エンドポイントを設定します。Stripe が Webhook イベントの生成に使用する API バージョンと、リッスンするイベントタイプを選択し、サーバーが Webhook エンドポイントをホストする HTTPS URL を指定します。
ワークベンチの左側には、設定済みの Webhook エンドポイントが一覧表示されます。概要には、その設定済みのエンドポイントでのアクティビティーがまとめられ、イベントの送信先には Stripe からそのエンドポイントへのイベント送信の試行の一覧が表示されます。送信の試行の横にある今すぐ再試行をクリックすると、Stripe はそのエンドポイントにイベントを再送信できます。
新しい Webhook エンドポイントを設定するか、イベントをローカル開発マシンに振り分けます。
Shell と Explorer を使用して API コマンドを実行する
Shell はワークベンチ内で Stripe のリソースを管理するための、Stripe CLI に似たコマンドラインインターフェイスを提供します。利用可能なコマンドの一覧については、Shell と API Explorer をご覧ください。
注
Shell は本番環境では読み取り専用です。テスト環境に切り替えて、API オブジェクトを作成、修正、削除する API リクエストを実行します。
ワークベンチの使用時に、いつでも最小化された Shell をペインで利用できますが、Shell タブを使用して全画面のセッションを起動することもできます。Shell タブで新しいペインをクリックして、複数のシェルセッションにペインを分割します。
API Explorer をクリックすると、インタラクティブなコマンドビルダーが右側に表示されます。API リソースと HTTP メソッドを選択して、対象のリクエストの必須とオプションのパラメーターを表示します。ヘッダータブでは、連結アカウントへの API リクエストを実行できるようにする Stripe-Account
ヘッダーなど、いくつかの HTTP ヘッダーを設定できます。実行をクリックして、API リクエストを実行します。
API Explorer にパラメーターを入力すると、対応する Shell コマンドが自動的に構築されます。プログラミング言語を選択して、SDK リクエストを出力するをクリックし、API リクエストに対応する SDK コードを確認します。
Shell と API Explorer は、ワークベンチから Stripe の API を試行するのに役立ちます。