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

By default, all accounts have a total of four API keys, two in a sandbox and two in live mode:

• Sandbox secret key: Use this key to authenticate requests on your server when you’re testing in a sandbox. By default, you can use this key to perform any API request without restriction. Reserve this key for testing and development to make sure that you don’t accidentally modify your live customers or charges.
• Sandbox publishable key: Use this key for testing purposes in your web or mobile app’s client-side code. Reserve this key for testing and development to make sure that you don’t accidentally modify your live customers or charges.
• 本番環境のシークレットキー: 本番環境でサーバー上のリクエストを認証するには、このキーを使用します。デフォルトでは、このキーを使用して、あらゆる API リクエストを制限なく実行できます。
• 本番環境の公開可能キー: アプリをリリースする準備が整ったら、ウェブやモバイルアプリのクライアント側コードでこのキーを使用します。

Your secret and publishable keys are in the Dashboard in the API keys tab. If you can’t view your API keys, ask the owner of your Stripe account to add you to their team with the proper permissions.

When you’re logged in to Stripe, our documentation automatically populates code examples with your test API keys. Only you can see these values. If you’re not logged in, our code examples include randomly generated API keys. You can replace them with your own test keys or log in to see the code examples populated with your test API keys.

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