本番環境開始のチェックリスト
自社で構築した Stripe システムを本番環境に円滑に移行できるよう、このチェックリストをご利用ください。
注
Stripe パートナーになることで、その他のベストプラクティスにアクセスしたり、Stripe から関連するニュースや最新情報を受け取ることができます。
Stripe は、本番環境とサンドボックス環境が可能な限り同じように動作するように設計しています。環境の切り替えは、大抵 API キーの交換によって行われます。
開発者の場合、または開発者に導入を依頼した場合は、本番環境へ移行する前に次の項目についても検討する必要があります。連結されたウェブサイトまたはプラグインを通じて Stripe を使用している場合は、ほとんどが当てはまりません。
警告
API バージョンを上書きしない限り、リクエストはすべて、アカウントの API 設定を使用します。変更ログには、使用可能なすべてのバージョンが記載されます。エンドポイントの作成中に API バージョンを設定しない限り、デフォルトでは Webhook イベントはアカウントの API バージョンに従って構造化されることに注意してください。
強力な型付き言語 (Go、Java、TypeScript、.NET) を使用している場合、サーバー側のライブラリは、使用されているライブラリのバージョンに基づいて API バージョンを固定します。バージョン管理に関するドキュメントを参照して、Stripe によるバージョン管理方法の詳細について理解を深めてください。
以下の方法ですべてが同期していることを確認します。
- ダッシュボード内のワークベンチで最新の API バージョンにアップグレードします。
- 動的言語 (Node.js、PHP、Python、Ruby) の場合は、サーバー側ライブラリの API バージョンを設定します
- 強力な型付き言語 (Go、Java、TypeScript、.NET) の場合は、選択したライブラリの最新バージョンにアップグレードします
Stripe では、いくつかのテスト値を用意しており、これを使用してさまざまな状態とレスポンスを再現できます。これらのオプションに加えて、以下のデータでシステムをテストしてデューデリジェンスを行ってください。
- 不完全なデータ
- 無効なデータ
- 重複データ (たとえば、同じリクエストを再試行してどうなるかを確認する)。また、実装のテストを他の人 (特に開発者ではない人) に依頼することもお勧めします。
本番環境に移行した後で、「起きてはならない」エラーを含め、考えられるすべてのエラータイプを処理するコードが正しく記述されていなかったことに気付くのは望ましいことではありません。コードが防御的であり、一般的なエラーだけでなく、可能性のあるすべてのエラーを処理できることを確認してください。
エラー処理をテストするときは、ユーザーに表示される情報に特に注意して確認してください。拒否されたカード (
card_など) は、バックエンドのエラー (error invalid_など) とは別の問題です。request_ error Stripe は、API キーを使用して行われたすべてのリクエストをログに記録しており、これらの記録はダッシュボードで確認できます。不要に思われるかもしれませんが、すべての重要なデータをお客様側でもログに記録することをお勧めします。お客様のサーバーが Stripe に接続できない場合、または API キーに問題がある場合、リクエストをログに記録できなくなるため、お客様自身のログがあれば非常に有益です。
ログを定期的に検査して、必要な情報のみがログに保存されていること、機密性の高い情報 (クレジットカードの詳細や個人を特定できる情報など) は保存されていないことを確認してください。
サンドボックス環境で作成された Stripe オブジェクト (プラン、クーポン、商品、SKU など) は、本番環境では使用できません。これにより、テストデータが本番コードで誤って使用されることがなくなります。本番環境で必要なオブジェクトを再作成するときは、必ず同じ ID 値 (たとえば、同じ「名前」ではなく同じプラン 「ID」) を指定して、コードが問題なく動作し続けるようにしてください。
Stripe アカウントでは、テスト用と本番用の両方の Webhook エンドポイントを設定できます。Webhook を使用している場合は、Stripe アカウントで本番用エンドポイントを定義していることを確認してください。その後、本番用エンドポイントがテスト用エンドポイントとまったく同じように機能することを確認します。
Webhook のステータスを確認しながら、本番用エンドポイントが次のとおりであることを確認してください。
- 遅延する Webhook 通知を適切に処理できる
- 重複する Webhook 通知を適切に処理できる
- イベント通知を特定の順序で行う必要がない
すべての開発者が API の更新メーリングリストに登録して、Stripe がリリースする新機能を常に把握できるようにしておくことをお勧めします。
セキュリティ対策として、API キーのローテーションを定期的に行い、本番環境に移行する直前にローテーションすることをおすすめします。これは、開発中にコードベースの外部のどこかに保存された場合に備えています。ワークフローによって API キーが複数の場所で表現または保存されたり (バグの原因)、バージョン管理ソフトウェアで終了したりしないようにしてください。