Mirakl Connector の設定
統合変数を定義します。
Before installing the plugin , prepare a file with the variables below.
Stripe のリポジトリには、設定ファイルのサンプルがあります。このファイルをコピーし、名前を . に変更できます。
一般的な設定
| パラメータ | 説明 |
|---|---|
| APP_SECRET | 生成されます。一般に、セキュリティ関連の操作にエントロピーを追加するために使用されます。詳細は Symfony のドキュメントをご覧ください。 |
| OPERATOR_PASSWORD | To be generated. Used to secure requests to the API exposed by the plugin . Set the X-AUTH-TOKEN header to this value when calling the API. |
| DATABASE_URL | データベースへの接続 URL。詳細については、Doctrine のドキュメントをご覧ください。例: pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8。 |
| MESSENGER_TRANSPORT_DSN | キューイングシステムに使用されるトランスポート。サポート対象のトランスポートについては、Symfony Messenger のドキュメントをご覧ください。例: amqp://guest:guest@localhost:5672/%2f/messages。デフォルトは、doctrine://default です。 |
| STRIPE_CLIENT_SECRET | Your Stripe API secret key available in your API keys settings. We recommend creating a specific API key for the plugin. Restricted keys are not supported. |
| MIRAKL_HOST_NAME | Mirakl インスタンスのホスト名。例: https://mymarketplace.。 |
| MIRAKL_API_KEY | The Mirakl operator key. Can be generated as a Mirakl operator in your API settings. We recommend creating a specific operator for the plugin. |
ユーザ登録
| パラメータ | 説明 |
|---|---|
| REDIRECT_ONBOARDING | The plugin redirects the seller to this URL after completing their account creation on Stripe. Defaults to $MIRAKL_. |
| BASE_HOST | The domain of the server hosting your plugin. For example, stripe-mirakl.. |
| SCHEME | ベースホストが使用するスキーム。デフォルトは https です。 |
| STRIPE_SELLERS_WEBHOOK_SECRET | エンドポイントを追加する際、Stripe Webhook シークレットは Connect の Webhook 設定から利用できます。下記をご確認ください。 |
| MIRAKL_CUSTOM_FIELD_CODE | 追加する必要のあるカスタムフィールドのコード。以下をご確認ください。デフォルトは stripe-url です。 |
連結アカウントの Stripe Webhook エンドポイントの追加
- Webhook 設定に移動します。
- Webhook エンドポイントを追加します。
- URL を
<BASE_に設定します。HOST>/api/public/webhook/sellers - 連結アカウントでイベントをリッスンするを選択します。
- 送信イベントに
account.を追加します。updated - エンドポイントを追加をクリックします。
- その Webhook シークレットを
STRIPE_環境変数に使用します。SELLERS_ WEBHOOK_ SECRET
Mirakl ショップへのカスタムフィールドの追加
- Mirakl バックオフィスにオペレータとしてログインします。
- Settings > Advanced Parameters > Shops にアクセスします。
- カスタムフィールドタブに移動します。
- 次の値を使用して、新しいフィールドを作成します。
| パラメータ | 説明 |
|---|---|
| コード | 環境ファイルで別のキーを選択しない限り、stripe-url を使用します。 |
| タイプ | Link |
| 店舗の権限 | Read only |
| 必須フィールド | No |
支払い
| パラメータ | 説明 |
|---|---|
| PAYMENT_METADATA_COMMERCIAL_ORDER_ID | Mirakl の業務用注文 ID を伝えるために Charges で使用されるメタデータキー。デフォルトは mirakl_。 |
| ENABLE_PRODUCT_PAYMENT_SPLIT | Enable the payment split workflow for product orders. Defaults to false. |
| ENABLE_SERVICE_PAYMENT_SPLIT | Enable the payment split workflow for service orders. Defaults to false. |
| ENABLE_PRODUCT_PAYMENT_REFUND | Enable the payment refund workflow for product orders. Defaults to false. |
| ENABLE_SERVICE_PAYMENT_REFUND | Enable the payment refund workflow for service orders. Defaults to false. |
| STRIPE_OPERATOR_WEBHOOK_SECRET | エンドポイントを追加する際、Stripe Webhook シークレットはアカウントの Webhook 設定から利用できます。下記をご確認ください。 |
アカウントの Stripe Webhook エンドポイントの追加
- Webhook 設定に移動します。
- アカウントの Webhook エンドポイントを追加します。
- URL を
<BASE_に設定します。HOST>/api/public/webhook/operator - 送信イベントに以下を追加します:
charge.、succeeded charge.。updated - エンドポイントを追加をクリックします。
- その Webhook シークレットを
STRIPE_環境変数に使用します。OPERATOR_ WEBHOOK_ SECRET
通知と警告
| パラメータ | 説明 |
|---|---|
| MAILER_DSN | DSN のような URL フォーマットを使用した Symfony Mailer 設定全体。詳細は Symfony のドキュメントをご覧ください。例: smtp://user:pass@host:port。デフォルトは smtp://null (メーラーは無効) です。 |
| TECHNICAL_ALERT_EMAIL | すべての技術的なアラートの受信者。例: myemail@example.。デフォルトは空ですが、MAILER_ ごとにメーラーが有効になっている場合は必須です。 |
| TECHNICAL_ALERT_EMAIL_FROM | すべての技術的なメールの送信者。デフォルトは空ですが、メーラーが設定されている場合は必須です。例: noreply@example.。 |
| OPERATOR_NOTIFICATION_URL | The endpoint on your server set to receive notifications from the plugin. Defaults to empty (notifications disabled). |
| MAIL_ON_NOTIFICATION_ENDPOINT_DOWN | URL が OPERATOR_ で指定されていて、その URL が利用できない場合、または応答でエラーが発生する場合に、メールアラートを有効にします。デフォルトは true です。 |
| MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN | メールによる各アラート間の時間間隔。スロットリングを無効にするには、0 を使用します。最大値は通知ワーカーの最大寿命 (デフォルトは 3600) によって異なります。デフォルトは 10 です。 |