最初の Stripe API リクエストを送信する

このガイドでは、Stripe API のシンプルな操作で顧客を作成する方法について手順を追って説明します。Stripe API オブジェクトと、どのように組み合わせるかについては、API の概要をご覧になるか、API リファレンスをご覧ください。支払いの受け付けを開始する準備ができている場合は、クイックスタートをご覧ください。

Stripe Shell を使用して、Stripe API の探索を開始します。Stripe Shell を使用すると、Stripe ドキュメントサイト内で直接 Stripe CLI コマンドを実行できます。これはサンドボックス環境でのみ動作するため、実際の資金移動取引が行われることについて心配する必要はありません。

1. Stripe Shell を使用して顧客を作成するには、次のコマンドを入力します。

   Command Line

   stripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer"

   すべて正常に機能する場合、コマンドラインに以下のレスポンスが表示されます。

   {
     "id": 
   "cus_LfctGLAICpokzr",
     "object": 
   "customer",

   31 行すべてを表示する

2. (オプション) サンドボックスで API シークレットキーを渡して、同じコマンドを実行します。

   Command Line

   stripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer" --api-key sk_test_BQokikJOvBiI2HlWgH4olfQ2

   すべて正常に機能する場合、コマンドラインに以下のレスポンスが表示されます。

   {
     "id": 
   "cus_LfdZgLFhah76qf",
     "object": 
   "customer",

   32 行すべてを表示する

Stripe API を呼び出すたびに、Stripe はStripe ユーザーアカウントの API オブジェクトと Events オブジェクトを作成・保存します。リクエストに指定する API キーによって、オブジェクトがサンドボックス環境に保存されるか、本番環境に保存されるかが決まります。たとえば、前回のリクエストで API シークレットキーが使用されていると、Stripe はオブジェクトをサンドボックスに保存します。

• API リクエストログを表示するには、以下を行います。

  • ログページを開きます。
  • 200 OK POST /v1 customers をクリックします。

• イベントログを表示するには、以下を行います。

  • イベントページを開きます。
  • jane.smith@email.com is a new customer をクリックします。

すべてのアカウントにはデフォルトで、サンドボックス用に 2 つ、本番環境用に 2 つの合計 4 つの API キーがあります。

• サンドボックスのシークレットキー:サンドボックスでテストするときに、サーバー上のリクエストを認証するには、このキーを使用します。デフォルトでは、このキーを使用して、あらゆる API リクエストを制限なく実行できます。誤って実際の顧客や支払いを変更しないように、このキーはテストと開発用に予約してください。
• サンドボックスの公開可能キー:ウェブやモバイルアプリのクライアント側コードでテストするには、このキーを使用します。誤って実際の顧客や支払いを変更しないように、このキーはテストと開発用に予約してください。
• 本番環境のシークレットキー: 本番環境でサーバー上のリクエストを認証するには、このキーを使用します。デフォルトでは、このキーを使用して、あらゆる API リクエストを制限なく実行できます。
• 本番環境の公開可能キー: アプリをリリースする準備が整ったら、ウェブやモバイルアプリのクライアント側コードでこのキーを使用します。

シークレットキーと公開可能キーは、ダッシュボードの API キータブに表示されます。API キーが表示されない場合は、Stripe アカウントの所有者に、適切な権限でご自身をチームに追加してもらうよう依頼してください。

Stripe にログインしている場合、Stripe のドキュメントにはお客様のテスト API キーを使用したコードサンプルが自動的に表示されます。お客様のみこの値を確認できます。ログインしていない場合、コードサンプルにはランダムに生成された API キーが含まれます。それらをお客様固有のテストキーに置き換えるか、ログインして、テスト API キーが入力されたコードサンプルを確認できます。

次の表は、ランダムに生成されたシークレットキーと公開可能テスト API キーの例です。