Stripe Payment Composable Connector for Commercetools をインストールして設定する

Commercetools Merchant Center を設定してコンポーザブルコネクターをインストールする方法をご紹介します。

Integrate Stripe Payments with Commercetools Composable Commerce, to create a custom checkout workflow that supports your business requirements and commerce storefront. For a pre-built checkout configuration, learn about our app for Commercetools Checkout.

Commercetools Merchant Center に掲載されている Connector

はじめに

Stripe Payment Composable Connector をインストールする前に、次のことを行ってください。

コネクターをインストールする Commercetools インスタンス内の組織とプロジェクトを指定します。
Commercetools インスタンスから直接コネクターをインストールして設定する準備をします。

Install the app

Commercetools インスタンスの Connect Marketplace から、Stripe Payment for Composable Commerce を選択します。
On the Commercetools configuration page, select the region, organization, and projects in which to install the app.
次に、環境変数と設定の詳細を指定します。
Stripe ダッシュボードで、テスト取引の URL を使用して Webhook を作成し、Webhook 署名シークレットをコピーします。テスト取引の URL は、認証が成功すると、デプロイ後スクリプトによって正しい URL に自動的に更新されます。

Configure the app

次のインストール変数を使用して、コネクターを設定します。

変数	説明
`CTP_API_URL`	Commercetools コンポーザブルコマース API の URL。デフォルト値は `https://api.europe-west1.gcp.commercetools.com` です。
`CTP_AUTH_URL`	OAuth 2.0 トークンの生成に使用される Commercetools プラットフォームでの認証用の URL。Commercetools コンポーザブルコマースへのすべての API コールには、OAuth 2.0 トークンが必要です。デフォルト値は `https://auth.europewest1.gcp.commercetools.com` です。
`CTP_CLIENT_ID`	Commercetools コンポーザブルコマースユーザーアカウントのクライアント ID。Commercetools クライアントはクライアント ID を使用して、SDK を介して Commercetools コンポーザブルコマースと通信します。
`CTP_CLIENT_SECRET`	Commercetools コンポーザブルコマースユーザーアカウントの Client Secret。Commercetools クライアントは Client Secret を使用して、SDK を介して Commercetools コンポーザブルコマースと通信します。
`CTP_JWKS_URL`	JSON Web キーセットを提供する URL。
`CTP_JWT_ISSUER`	JWT 検証プロセスに必要な JSON Web トークンの発行者。
`CTP_PROJECT_KEY`	Commercetools コンポーザブルコマースプロジェクトのキー。
`CTP_SCOPE`	スコープは、Commercetools クライアントがアクセスでき、読み取りと書き込みのアクセス権を持つエンドポイントを定義します。
`CTP_SESSION_URL`	The URL for session creation in the Commercetools platform. Apps rely on the created session to share information between the enabler and the processor. The default value is `https://session.europewest1.gcp.commercetools.com`.
`STRIPE_APPEARANCE_EXPRESS_CHECKOUT`	Stripe Elements はデザインのカスタマイズに対応しており、デザインオプションでサイトのデザインと親和性を持たせることができます。この値は、Express Checkout Element のデザインを定義します。
`STRIPE_APPEARANCE_PAYMENT_ELEMENT`	Stripe Elements はデザインのカスタマイズに対応しており、デザインオプションでサイトのデザインと親和性を持たせることができます。この値は、Payment Element のデザインを定義します。
`STRIPE_CAPTURE_METHOD`	Stripe のキャプチャー方法 (手動または自動)。デフォルト値は `automatic` です。
`STRIPE_SECRET_KEY`	Stripe はアカウントの API キーを使用して API リクエストを認証します。デフォルトのシークレット API キーを使用する代わりに、制限付きアクセスキーを作成することをお勧めします。
`STRIPE_WEBHOOK_ID`	Webhook エンドポイントに対する Stripe の一意の識別子。
`STRIPE_WEBHOOK_SIGNING_SECRET`	Webhook の署名を検証するために公式ライブラリで使用される Stripe シークレットキー。このキーは Stripe ダッシュボードで作成されます。

この支払いコネクターは、次の 2 つの主要リンクを作成します。

Payment Connector JS Enabler コンポーネント: 支払いコンポーネントが埋め込まれている URL (例: https://assets-{{uuid}}.assets.uscentral1.gcp.preview.commercetools.app/connector-enabler.es.js)
Payment Connector のプロセッサー: すべての Webhook が送信され、Commerceetools の支払いトランザクションに変換される URL (例: https://service-{{uuid}}.uscentral1.gcp.preview.commercetools.app)

決済システムを拡張する

特定のニーズに合わせて既存の決済システムを構築および拡張する場合は、以下の手順に従います。

GitHub で入手できるコネクターコードベースを使用します。
コネクターをローカルにデプロイします。
プロセッサーとイネーブラーの両方で .env 設定を更新します。

このパスを選択すると、コネクターのデプロイと設定に対する責任を負うことになります。

一般的な設定

Payment Connector の設定で、Payment Connector イネーブラーによって生成されたコンポーネントのキャプチャーモード (手動または自動) を変更できます。イネーブラーは、Payment Connector プロセッサーに接続されている支払いコンポーネントを管理します。プロセッサーは、Stripe でそれぞれのメタデータを設定した Payment Intent を作成し、Webhook イベントを Commercetools の支払い取引に変換します。

You can modify the appearance of the Stripe Payment Element and Express Checkout Element from the app configuration.

Webhook

Stripe は、貴社のアカウントでイベントが発生すると、Webhook を使用して貴社のアプリケーションに通知します。Webhook は、顧客の銀行が支払いを確認したときや支払いを拒否したとき、または支払いがキャンセルされたときや返金されたときに、支払い取引を更新するのに便利です。Stripe は次の Webhook に対応しています。

イベントタイプ	説明
`charge.refunded`	`charge.captured` が true の場合、Commercetools で支払いに `Refund:Success` 取引を追加します。
`charge.succeeded`	支払いがキャプチャーされていない場合は、Commercetools で支払いを作成します。支払いが行われた場合は、Commercetools で支払いに `Authorization:Success` 取引を追加します。
`payment_intent.canceled`	Commercetools で支払いに `CancelAuthorization:Success` 取引を追加します。
`payment_intent.payment_failed`	コネクターアプリのプロセッサーログの情報を記録します。
`payment_intent.requires_action`	コネクターアプリのプロセッサーログの情報を記録します。
`payment_intent.succeeded`	このイベントは、次のいずれかのキャプチャー方法を使用して処理できます。自動: `paymentIntent.capture_method` が自動の場合は、Commercetools で支払いを作成して、それに `Charge:Success` 取引を追加します。手動: `paymentIntent.capture_method` が手動の場合は、Commercetools で支払いに `Charge:Success` 取引を追加します。

変更ログとコードへのアクセス

コネクターへの変更とアップグレードの最新状況は、Github リポジトリで確認できます。

注