Konfigurieren Sie die Mirkal-App

Definieren Sie Ihre Integrationsvariablen.

Bevor Sie die Mirakl-App installieren, bereiten Sie eine Datei mit den in diesem Handbuch beschriebenen Variablen vor. Um zu starten, können Sie unsereBeispiel-Konfigurationsdatei kopieren und umbenennen in.env.

Allgemeine Einstellungen

Konfigurieren Sie die allgemeinen Einstellungen der App:

Parameter	Beschreibung
`APP_SECRET`	Muss generiert werden. Wird oft verwendet, um sicherheitsrelevante Abläufe durch Entropie abzusichern. Mehr erfahren Sie in der Dokumentation zu Symfony.
`OPERATOR_PASSWORD`	Zu generieren. Wird verwendet, um Anfragen an die API zu sichern, die vom Plugin verfügbar gemacht werden. Setzen Sie den Header `X-AUTH-TOKEN` auf diesen Wert beim Aufruf der API.
`DATABASE_URL`	Die Verbindungs-URL für Ihre Datenbank. Mehr erfahren Sie in der Dokumentation zu Doctrine. Beispiel: `pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8`.
`MESSENGER_TRANSPORT_DSN`	Die für das Warteschlangensystem verwendete Übertragung. Welche Übertragungen unterstützt werden, erfahren Sie in der Dokumentation zu Symfony Messenger. Beispiel: `amqp://guest:guest@localhost:5672/%2f/messages`. Standardmäßig wird `doctrine://default` verwendet.
`STRIPE_CLIENT_SECRET`	Ihr API-GeheimschIüssel von Stripe in den Einstellungen für API-Schlüssel. Wir empfehlen, einen spezifischen API-Schlüssel für das Plugin zu erstellen. Eingeschränkte Schlüssel werden nicht unterstützt.
`MIRAKL_HOST_NAME`	Hostname Ihrer Mirakl-Instanz. Beispiel: `https://mymarketplace.mirakl.net`.
`MIRAKL_API_KEY`	Der Mirakl-Operatorschlüssel. Kann als Mirakl-Operator in Ihren API-Einstellungen generiert werden. Wir empfehlen, einen spezifischen Operator für das Plugin zu erstellen.

Onboarding

Konfigurieren Sie die Onboarding-Einstellungen der App:

Parameter	Beschreibung
`REDIRECT_ONBOARDING`	Das Plugin leitet Verkäufer/innen zu dieser URL weiter, nachdem sie die Kontoerstellung bei Stripe abgeschlossen haben. Der Standardwert lautet `$MIRAKL_HOST_NAME/mmp/shop/account/shop`.
`BASE_HOST`	Die Domain des Servers, der Ihr Plugin hostet. Beispiel: `stripe-mirakl.example.com`.
`PLAN`	Das von Ihrem Basis-Host verwendete Schema. Grundsätzlich `https`.
`STRIPE_SELLERS_WEBHOOK_SECRET`	Ihr Stripe-Webhook-Geheimnis ist beim Hinzufügen des Endpoints in Ihren Webhook-Einstellungen verfügbar. Weitere Informationen finden Sie unter Stripe-Webhook-Endpoint für verbundene Konten hinzufügen.
`MIRAKL_CUSTOM_FIELD_CODE`	Code des benutzerdefinierten Felds, das Sie hinzufügen müssen (siehe unten). Der Standardwert lautet `stripe-url`.

Webhook-Endpoint von Stripe für verbundene Konten hinzufügen

Wechseln Sie zu Ihren Webhook-Einstellungen.
Fügen Sie einen webhook-Endpoint hinzu, indem Sie auf die Schaltfläche Ziel hinzufügen klicken.
Wählen Sie Verbundene Konten aus den Optionen Ereignisse von und wählen Sie account.updated aus der Liste der verfügbaren Ereignisse. Geben Sie die gewünschte Stripe-API-Version ein. Klicken Sie auf Fortfahren.
Wählen Sie Webhook-Endpoint aus der Liste der verfügbaren Zieltypen. Klicken Sie auf Fortfahren.
Setzen Sie die Endpoint-URL auf <BASE_HOST>/api/public/webhook/sellers und füllen Sie die übrigen Felder wie gewünscht aus.
Klicken Sie auf Ziel erstellen.
Verwenden Sie den Webhook-Geheimschlüssel für die Umgebungsvariable STRIPE_SELLERS_WEBHOOK_SECRET.

Benutzerdefiniertes Feld zu Mirakl-Shops hinzufügen

Melden Sie sich im Mirakl-Backoffice als Operator an.
Gehen Sie zu Settings > Advanced Parameters > Shops (Einstellungen > Erweiterte Parameter > Shops).
Gehen Sie zu Benutzerdefinierte Felder.
Erstellen Sie ein neues Feld mit den folgenden Werten:

Parameter	Beschreibung
Code	Verwenden Sie `stripe-url`, wenn Sie nicht in Ihrer Umgebungsdatei einen anderen Schlüssel gewählt haben.
Type (Typ)	`Link`
Shops permissions (Berechtigungen für Shops)	`Read only`
Required field (Pflichtfeld)	`No`

Zahlungen

Konfigurieren Sie die Zahlungseinstellungen der App:

Parameter	Beschreibung
`PAYMENT_METADATA_COMMERCIAL_ORDER_ID`	Metadatenschlüssel, der in Charges verwendet wird, um die ID der kommerziellen Mirakl-Bestellung zu übermitteln. Der Standardwert lautet `mirakl_commercial_order_id`.
`ENABLE_PRODUCT_PAYMENT_SPLIT`	Aktivieren des Ablaufs für die Zahlungsaufteilung für Produktbestellungen. Der Standardwert lautet `false`.
`NABLE_SERVICE_PAYMENT_SPLIT`	Aktivieren des Ablaufs für die Zahlungsaufteilung für Servicebestellungen. Der Standardwert lautet `false`.
`ENABLE_PRODUCT_PAYMENT_REFUND`	Aktivieren des Ablaufs für die Zahlungsrückerstattung für Produktbestellungen. Der Standardwert lautet `false`.
`ENABLE_SERVICE_PAYMENT_REFUND`	Aktivieren des Ablaufs für die Zahlungsrückerstattung für Servicebestellungen. Der Standardwert lautet `false`.
`STRIPE_OPERATOR_WEBHOOK_SECRET`	Ihr Stripe-Webhook-Geheimnis ist auf Ihrer Konto-Ereignis-Detailseite verfügbar, wenn Sie den Endpoint hinzufügen. Weitere Informationen finden Sie unter Einen Stripe-Webhook-Endpoint für Ihr Konto hinzufügen.

Webhook-Endpoint von Stripe für Ihr Konto hinzufügen

Wechseln Sie zu Ihren Webhook-Einstellungen.
Fügen Sie einen webhook-Endpoint hinzu, indem Sie auf die Schaltfläche Ziel hinzufügen klicken.
Wählen Sie Ihr Konto aus den Optionen Ereignisse von und wählen Sie charge.succeeded und charge.updated aus der Liste der verfügbaren Ereignisse. Geben Sie die gewünschte Stripe-API-Version ein. Klicken Sie auf Fortfahren.
Wählen Sie Webhook-Endpoint aus der Liste der verfügbaren Zieltypen. Klicken Sie auf Fortfahren.
Setzen Sie die Endpoint-URL auf <BASE_HOST>/api/public/webhook/operator und füllen Sie die übrigen Felder wie gewünscht aus.
Klicken Sie auf Ziel erstellen.
Verwenden Sie den Webhook-Geheimschlüssel für die Umgebungsvariable STRIPE_OPERATOR_WEBHOOK_SECRET.

Benachrichtigungen

Konfigurieren Sie die Benachrichtigungs- und Warnhinweiseinstellungen der App:

Parameter	Beschreibung
`MAILER_DSN`	Die gesamte Konfiguration von Symfony Mailer in einem DSN-ähnlichen URL-Format. Mehr erfahren Sie in der Dokumentation zu Symfony. Beispiel: `smtp://user:pass@host:port`. Der Standardwert lautet `smtp://null` (Mailer deaktiviert).
`TECHNICAL_ALERT_EMAIL`	Der Empfänger aller technischen Benachrichtigungen. Beispiel: `myemail@example.com`. Standardmäßig leer. Erforderlich, wenn der Mailer per `MAILER_DSN` aktiviert ist.
`TECHNICAL_ALERT_EMAIL_FROM`	Der Absender aller technischen Benachrichtigungen. Standardmäßig leer. Erforderlich, wenn der Mailer konfiguriert ist. Beispiel: `noreply@example.com`.
`OPERATOR_NOTIFICATION_URL`	Der Endpoint auf Ihrem Server, der für den Empfang von Benachrichtigungen vom Plugin eingerichtet ist. Standardmäßig leer (Benachrichtigungen deaktiviert).
`MAIL_ON_NOTIFICATION_ENDPOINT_DOWN`	Aktivieren von E-Mail-Benachrichtigungen, wenn eine URL in `OPERATOR_NOTIFICATION_URL` angegeben ist und diese URL nicht verfügbar ist oder mit einem Fehler antwortet. Der Standardwert lautet `true`.
`MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN`	Die Zeit zwischen den einzelnen E-Mail-Benachrichtigungen. Bei `0` findet keine Verzögerung statt. Der Maximalwert hängt von der maximalen Lebensdauer von Notification Worker ab (standardmäßig `3600`). Der Standardwert lautet `10`.