Shell と API Explorer

実装の管理や API の確認には、コマンドラインインターフェイスを使用します。

Shell はワークベンチ内のコマンドラインインターフェイスであり、Stripe CLI で構築されているコマンドと同じコマンドを数多く提供しています。ワークベンチを使用する際は、画面の下部でいつでも最小限の Shell を使用できます。または、Shell タブを使用してフルスクリーンのセッションを起動することもできます。

次の Shell 機能を利用すると Stripe システムの管理とデバッグを行うことができます。

オートコンプリート機能: Shell で Tab キーを押すと API リクエストと CLI コマンドの補完機能が働きます。
API Explorer: 標準搭載されている API Explorer を使用すると、API リソースの詳細を確認しながら、Shell で API コールを構築できます。

注

Shell はブラウザーで実行されるため、Stripe CLI と比べるといくつか制約があります。Stripe CLI では、ローカルのイベントリスナーを使用してローカルマシンで Webhook イベントの受信とトリガーを行うことができます。詳細は Stripe CLI で Webhook との連携をテストするをご覧ください。

初期セットアップ

ダッシュボードにサインインします。開発者メニューでワークベンチをクリックします。Shell タブに切り替えます。

よくある間違い

Shell は本番環境では読み取り専用です。テスト環境に切り替えて、API オブジェクトを作成、修正、削除する API リクエストを実行します。

イベントをリッスンする

コマンドラインプロンプトで、stripe listen と入力して Webhook イベントをリッスンしてから、キーボードの Enter を押してコマンドを実行します。

Command Line

stripe listen

これによって、Stripe アカウントの受信イベントをリッスンします。

最初の API リクエストを実行します。

新しいペインをクリックすると、既存のセッションの横の画面に新しいセッションが開きます。
コマンドをコピーして、コマンドラインプロンプトに貼り付け、キーボードの Enter を押します。
後続のリクエストのレスポンスで、(id 内の) オブジェクト ID をコピーします。

Command Line
stripe products create \
--name="Introductory offer (Monthly)" \
--description="$0.99 per month"

これで、名前と説明を持つ商品が作成されます。

API Explorer を使用する

API Explorer をクリックすると、右側にインタラクティブな API Explorer が表示されます。
Products リソースと Update メソッドを選択します。API Explorer に、 Products リソースの必須パラメーターとオプションのパラメーターが表示されます。
前のステップからのオブジェクト ID を id パス引数の Value に貼り付けます。API Explorer で既存のオブジェクト ID を指定すると、その既存の商品のプロパティが読み込まれます。
オプションのパラメーター description を月額 1.99 USD に更新します。API Explorer によって、商品の説明を更新する API コマンドが Shell に自動的に表示されます。Enter キーを押してコマンドを実行し、商品を更新します。
Print SDK code (SDK コードを出力する) をクリックすると、選択した言語に対応するコードスニペットを確認できます。

利用可能なコマンド

Shell は stripe コマンドに加えて複数のコマンドを提供します (Stripe CLI リファレンスをご覧ください)。

コマンド	目的
`cd`	別のドキュメントページに移動します
`clear`	shell から以前のテキストをすべて消去します
`ls`	現在のページに関連するダッシュボードページを一覧表示します
`pwd`	現在のページのスラグとタイトルを出力します
`shortcuts`	Shell で使用できるキーボードショートカットを表示します
`stripe`	利用可能な Stripe CLI コマンド (リファレンスの全文をご覧ください)
`whoami`	ログインした加盟店の詳細を表示します