最初の 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_4eC39HqLyjWDarjtT1zdp7dc

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

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

   32 行すべてを表示する

Stripe API を呼び出すたびに、Stripe ユーザーアカウントの API オブジェクトと Event (イベント) オブジェクトが作成され、保管されます。リクエストに指定する API キーによって、オブジェクトがテスト環境と本番環境のどちらに保管されるかが決まります。たとえば、前回のリクエストでは API シークレットキーを使用したため、テスト環境にオブジェクトが保管されています。

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

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

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

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

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

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

シークレットキーおよび公開可能キーは開発者ダッシュボードの API キーで確認できます。ログインしている場合、Stripe のドキュメントにはテスト環境の API キーを使用したコードサンプルが自動的に表示されます (これらの値はお客様にだけ表示されます)。ログインしていない場合、コードサンプルにはランダムに生成された API キーが含まれます。それらをお客様固有のキーに置き換えるか、ログインして、お客様固有のテスト API キーが入力されたコードサンプルを表示できます。API キーが表示されない場合は、Stripe アカウントの所有者に、適切な権限でご自身をチームに追加してもらうよう依頼してください。

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