# Mirakl アプリの設定 統合変数を定義します。 Mirakl アプリをインストールする前に、このガイドに概説されている変数を含むファイルを準備してください。始めるには、[サンプル設定ファイル](https://github.com/stripe/stripe-mirakl-connector/blob/master/.env.dist)をコピーし、`.env`にリネームします。 ## 一般的な設定 アプリの一般設定を行います。 | パラメータ | 説明 | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `APP_SECRET` | 生成されます。一般に、セキュリティ関連の操作にエントロピーを追加するために使用されます。詳細は [Symfony のドキュメント](https://symfony.com/doc/current/reference/configuration/framework.html#secret)をご覧ください。 | | `OPERATOR_PASSWORD` | 生成予定。プラグインによって公開される API へのリクエストを保護するために使用されます。API を呼び出すときに、`X-AUTH-TOKEN` ヘッダーをこの値に設定します。 | | `DATABASE_URL` | データベースへの接続 URL。詳細については、[Doctrine のドキュメント](https://www.doctrine-project.org/projects/doctrine-dbal/en/2.9/reference/configuration.html#connecting-using-a-url)をご覧ください。例: `pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8`。 | | `MESSENGER_TRANSPORT_DSN` | キューイングシステムに使用されるトランスポート。サポート対象のトランスポートについては、[Symfony Messenger のドキュメント](https://symfony.com/doc/current/messenger.html#transports-async-queued-messages)をご覧ください。例: `amqp://guest:guest@localhost:5672/%2f/messages`。デフォルトは、`doctrine://default` です。 | | `STRIPE_CLIENT_SECRET` | Stripe API シークレットキーは [API キー設定](https://dashboard.stripe.com/apikeys)にあります。プラグインに特定の API キーを作成することをお勧めします。制限付きキーはサポートされません。 | | `MIRAKL_HOST_NAME` | Mirakl インスタンスのホスト名。例: `https://mymarketplace.mirakl.net`。 | | `MIRAKL_API_KEY` | Mirakl Operator のキー。API 設定で Mirakl Operator として生成できます。プラグインには固有の Operator を作成することをお勧めします。 | ## ユーザ登録 アプリのユーザー登録設定を行います。 | パラメータ | 説明 | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `REDIRECT_ONBOARDING` | 売り手が Stripe でのアカウント作成を完了すると、プラグインによってこの URL にリダイレクトされます。デフォルトは `$MIRAKL_HOST_NAME/mmp/shop/account/shop` です。 | | `BASE_HOST` | プラグインをホスティングするサーバーのドメイン。例:`stripe-mirakl.example.com`。 | | `SCHEME` | ベースホストが使用するスキーム。デフォルトは `https` です。 | | `STRIPE_SELLERS_WEBHOOK_SECRET` | エンドポイントを追加する際、Stripe Webhook シークレットは [Connect Webhook 設定](https://dashboard.stripe.com/workbench/webhooks)で確認できます。詳細については、[連結アカウントの Stripe Webhook エンドポイントを追加する](https://docs.stripe.com/use-stripe-apps/mirakl/configuration.md#add-a-stripe-webhook-endpoint-for-connected-accounts)をご覧ください。 | | `MIRAKL_CUSTOM_FIELD_CODE` | 追加する必要のあるカスタムフィールドのコード。以下をご確認ください。デフォルトは `stripe-url` です。 | ### 連結アカウントの Stripe Webhook エンドポイントの追加 1. [Webhook 設定](https://dashboard.stripe.com/workbench/webhooks)に移動します。 1. **宛先を追加** ボタンをクリックして、*webhook* (A webhook is a real-time push notification sent to your application as a JSON payload through HTTPS requests) エンドポイントを追加します。 1. **イベント元**オプションから**連結アカウント**を選択し、利用可能なイベントのリストから `account.updated` を選択します。希望する Stripe API のバージョンを入力してください。**続行**をクリックします。 1. 使用可能な送信先タイプのリストから**Webhook エンドポイント**を選択します。**続行**をクリックします。 1. エンドポイント URL を`/api/public/webhook/sellers` に設定し、必要に応じて残りのフィールドに入力します。 1. **送信先を作成する**をクリックします。 1. その Webhook シークレットを `STRIPE_SELLERS_WEBHOOK_SECRET` 環境変数に使用します。 ### Mirakl ショップへのカスタムフィールドの追加 1. Mirakl バックオフィスにオペレータとしてログインします。 1. **Settings** > **Advanced Parameters** > **Shops** にアクセスします。 1. **Custom Fields** に移動します。 1. 以下の値を使用して新しいフィールドを作成します。 | パラメータ | 説明 | | ------- | ---------------------------------------- | | コード | 環境ファイルで別のキーを選択しない限り、`stripe-url` を使用します。 | | タイプ | `Link` | | 店舗の権限 | `Read only` | | 必須フィールド | `No` | ## 支払い アプリの決済設定を行います。 | パラメータ | 説明 | | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `PAYMENT_METADATA_COMMERCIAL_ORDER_ID` | Mirakl の業務用注文 ID を伝えるために Charges で使用されるメタデータキー。デフォルトは `mirakl_commercial_order_id`。 | | `ENABLE_PRODUCT_PAYMENT_SPLIT` | 商品の注文に関する[支払いの分割ワークフロー](https://docs.stripe.com/use-stripe-apps/mirakl/payments.md#payment-split)を有効にします。デフォルトは `false` です。 | | `NABLE_SERVICE_PAYMENT_SPLIT` | サービスの注文に関する[支払いの分割ワークフロー](https://docs.stripe.com/use-stripe-apps/mirakl/payments.md#payment-split)を有効にします。デフォルトは `false` です。 | | `ENABLE_PRODUCT_PAYMENT_REFUND` | 商品の注文に関する[決済返金ワークフロー](https://docs.stripe.com/use-stripe-apps/mirakl/payments.md#payment-refund)を有効にします。デフォルトは `false` です。 | | `ENABLE_SERVICE_PAYMENT_REFUND` | サービスの注文に関する[支払いの返金ワークフロー](https://docs.stripe.com/use-stripe-apps/mirakl/payments.md#payment-refund)を有効にします。デフォルトは `false` です。 | | `STRIPE_OPERATOR_WEBHOOK_SECRET` | エンドポイントを追加する際、Stripe Webhook シークレットは[アカウントのイベント送信先の詳細ページ](https://dashboard.stripe.com/workbench/webhooks)で確認できます。詳細については、[アカウントに Stripe Webhook エンドポイントを追加する](https://docs.stripe.com/use-stripe-apps/mirakl/configuration.md#add-a-stripe-webhook-endpoint-for-your-account)をご覧ください。 | ### アカウントの Stripe Webhook エンドポイントの追加 1. [Webhook 設定](https://dashboard.stripe.com/workbench/webhooks)に移動します。 1. **宛先を追加** ボタンをクリックして、*webhook* (A webhook is a real-time push notification sent to your application as a JSON payload through HTTPS requests) エンドポイントを追加します。 1. **イベント発生** オプションから **あなたのアカウント** を選択し、利用可能なイベントのリストから `charge.succeeded` と `charge.updated` を選択します。希望する Stripe API のバージョンを入力してください。**続行** をクリックします。 1. 使用可能な送信先タイプのリストから**Webhook エンドポイント**を選択します。**続行**をクリックします。 1. エンドポイント URL を `/api/public/webhook/operator` に設定し、必要に応じて残りのフィールドに入力します。 1. **送信先を作成する**をクリックします。 1. その Webhook シークレットを `STRIPE_OPERATOR_WEBHOOK_SECRET` 環境変数に使用します。 ## 通知と警告 アプリの通知とアラート設定を行います。 | パラメータ | 説明 | | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `MAILER_DSN` | DSN のような URL フォーマットを使用した Symfony Mailer 設定全体。詳細は [Symfony のドキュメント](https://symfony.com/doc/current/components/mailer.html#mailer-dsn)をご覧ください。例: `smtp://user:pass@host:port`。デフォルトは `smtp://null` (メーラーは無効) です。 | | `TECHNICAL_ALERT_EMAIL` | すべての技術的なアラートの受信者。例: `myemail@example.com`。デフォルトは空ですが、`MAILER_DSN` ごとにメーラーが有効になっている場合は必須です。 | | `TECHNICAL_ALERT_EMAIL_FROM` | すべての技術的なメールの送信者。デフォルトは空ですが、メーラーが設定されている場合は必須です。例: `noreply@example.com`。 | | `OPERATOR_NOTIFICATION_URL` | プラグインからの通知を受信するように設定されているお客様のサーバー上のエンドポイント。デフォルトは空 (通知が無効) です。 | | `MAIL_ON_NOTIFICATION_ENDPOINT_DOWN` | URL が `OPERATOR_NOTIFICATION_URL` で指定されていて、その URL が利用できない場合、または応答でエラーが発生する場合に、メールアラートを有効にします。デフォルトは `true` です。 | | `MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN` | メールによる各アラート間の時間間隔。スロットリングを無効にするには、`0` を使用します。最大値は通知ワーカーの最大寿命 (デフォルトは `3600`) によって異なります。デフォルトは `10` です。 |