最初の 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 をクリックします。

デフォルトでは、すべてのアカウントに合計 4 つの API キーがあります。

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

Stripe にログインしている場合、ドキュメントではコード例にテスト API キーが入力されます。これらの値はお客様のみが確認できます。ログインしていない場合、コード例にはランダムに生成された API キーが含まれ、これをテストキーに置き換えることができます。または、 ログイン して、テスト API キーが入力されたコード例を確認することもできます。

API キーの例

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