最初の Stripe API リクエストを送信する
Stripe API に対するすべてのコールには、API シークレットキーを含める必要があります。Stripe アカウントを作成すると、2 組の API キー (テスト環境用および本番環境用それぞれの、クライアント側の公開可能キーとサーバー側のシークレットキー) が生成されます。本番環境のキーを使用して実際に資金の移動を開始するには、本番環境の利用を申請する必要があります。
はじめに
このガイドでは、Stripe API のシンプルな実装で顧客を作成する方法について手順を追って説明します。Stripe API オブジェクトと、どのように連携するかについては、API の概要をご覧になるか、API リファレンスをご覧ください。支払いの受け付けを開始する準備ができている場合は、クイックスタートをご覧ください。
最初の API リクエストを送信する
Stripe Shell を使用して Stripe API を試してみることができます。Stripe Shell では、Stripe ドキュメントサイトから Stripe CLI コマンドを直接実行できます。テスト環境でのみ動作するため、資金の移動を伴う実際の取引が開始されることはありません。
Stripe Shell を使用して顧客を作成するには、次のコマンドを入力します。
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer"
すべて正常に機能する場合、コマンドラインに以下のレスポンスが表示されます。
{ "id":
, "object":"cus_LfctGLAICpokzr","customer"(オプション) テスト環境用の API シークレットキーを渡して同じコマンドを実行します。
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer" --api-key sk_test_4eC39HqLyjWDarjtT1zdp7dc
すべて正常に機能する場合、コマンドラインに以下のレスポンスが表示されます。
{ "id":
, "object":"cus_LfdZgLFhah76qf","customer"
ログとイベントを表示する
Stripe API を呼び出すたびに、Stripe ユーザーアカウントの API オブジェクトと Event (イベント) オブジェクトが作成され、保管されます。リクエストに指定する API キーによって、オブジェクトがテスト環境と本番環境のどちらに保管されるかが決まります。たとえば、前回のリクエストでは API シークレットキーを使用したため、テスト環境にオブジェクトが保管されています。
API キーを保存する
すべてのアカウントに、デフォルトで、テスト環境用に 2 つ、本番環境用に 2 つの合計 4 つの API キーがあります。
- テスト環境のシークレットキー: テスト環境でサーバー上のリクエストを認証するには、このキーを使用します。デフォルトでは、このキーを使用して、あらゆる API リクエストを制限なく実行できます。
- テスト環境の公開可能キー: ウェブやモバイルアプリのクライアント側コードでテストするには、このキーを使用します。
- 本番環境のシークレットキー: 本番環境でサーバー上のリクエストを認証するには、このキーを使用します。デフォルトでは、このキーを使用して、あらゆる API リクエストを制限なく実行できます。
- 本番環境の公開可能キー: アプリをリリースする準備が整ったら、ウェブやモバイルアプリのクライアント側コードでこのキーを使用します。
テストと開発
テストと開発にはテスト API キーのみを使用してください。こうすれば、誤って本番の顧客や支払いを変更する心配がありません。
You can find your secret and publishable keys in API keys. When you’re logged in, Stripe’s documentation automatically populates code examples with your test mode 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. 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.
次の表は、ランダムに生成されたシークレットキーと公開可能テスト API キーの例です。
制限付き API キー
The Dashboard can also generate restricted API keys, enabling customizable and limited access to the API. However, Stripe doesn’t offer any restricted keys by default.
タイプ | 値 | 使用するタイミング |
---|---|---|
シークレット | サーバー側: Stripe API を呼び出すウェブやモバイルアプリのサーバー側コード (環境変数や認証情報管理システムなど) でこれを安全に保管し、秘密にする必要があります。このキーをウェブサイトに公開したり、モバイルアプリケーションに埋め込んだりしないでください。 | |
公開可能 | クライアント側: ウェブやモバイルアプリのクライアント側コード (checkout.js など) でパブリックアクセスが可能であり、Stripe Elements などを使用して決済情報を安全に収集します。デフォルトでは、Stripe Checkout が決済情報を安全に収集します。 | |
制限付き | rk_test_ で始まる文字列 | マイクロサービス: Stripe API を呼び出すマイクロサービスコードでこれを安全に保管し、秘密にする必要があります。このキーをウェブサイトに公開したり、モバイルアプリケーションに埋め込んだりしないでください。 |