Konfiguration des Mirakl Connectors
Definieren Sie Ihre Integrationsvariablen.
Erstellen Sie vor der Installation des Connectors eine Datei mit den nachfolgenden Variablen.
Wir stellen in unserem Repository eine beispielhafte Konfigurationsdatei zur Verfügung, die Sie kopieren und in .env umbenennen können.
Allgemeine Einstellungen
| 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 | Muss generiert werden. Wird verwendet, um Anfragen an die API zu sichern, die vom Connector bereitgestellt wird. Setzen Sie den Header X-AUTH-TOKEN auf diesen Wert, wenn Sie die API aufrufen. |
| 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-Geheimschlüssel in den Einstellungen für API-Schlüssel. Wir empfehlen die Erstellung eines spezifischen API-Schlüssels für den Connector. 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 den Connector zu erstellen. |
Onboarding
| Parameter | Beschreibung |
|---|
| REDIRECT_ONBOARDING | Der Connector leitet Verkäufer/innen zu dieser URL weiter, wenn die Kontoerstellung auf Stripe abgeschlossen ist. Der Standardwert lautet $MIRAKL_HOST_NAME/mmp/shop/account/shop. |
| BASE_HOST | Die Domäne des Servers, der Ihren Connector hostet. Zum Beispiel stripe-mirakl.example.com. |
| SCHEMA | Das von Ihrem Basis-Host verwendete Schema. Grundsätzlich https. |
| STRIPE_SELLERS_WEBHOOK_SECRET | Ihr Webhook-Geheimschlüssel von Stripe, der in Ihren Connect-Einstellungen für Webhooks verfügbar ist, wenn Sie den Endpoint hinzufügen (siehe unten). |
| 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
- Rufen Sie die Webhook-Einstellungen auf.
- Webhook-Endpoint hinzufügen.
- Legen Sie die URL auf
<BASE_HOST>/api/public/webhook/sellers fest. - Wählen Sie Überwachen Sie Ereignisse von verbundenen Konten.
account.updated zu den zu sendenden Ereignissen hinzufügen:- Klicken Sie auf Endpunkt hinzufügen.
- 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).
- Rufen Sie die Registerkarte Custom Fields (Benutzerdefinierte Felder) auf.
- Erstellen Sie ein neues Feld mit 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
| 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. |
| ENABLE_SERVICE_PAYMENT_SPLIT | Aktivieren des Ablaufs für die Zahlungsaufteilung für Servicebestellungen. Der Standardwert lautet false. |
| ENABLE_PRODUCT_PAYMENT_REFUND | Aktivieren Sie den Workflow für die Rückerstattung von Zahlungen 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 Webhook-Geheimschlüssel von Stripe, der in den Webhook-Einstellungen Ihres Kontos verfügbar ist, wenn Sie den Endpoint hinzufügen (siehe unten). |
Webhook-Endpoint von Stripe für Ihr Konto hinzufügen
- Rufen Sie die Webhook-Einstellungen auf.
- Fügen Sie Ihrem Konto einen Webhook-Endpoint hinzu.
- Legen Sie die URL auf
<BASE_HOST>/api/public/webhook/operator fest. - Fügen Sie in Zu sendende Ereignisse Folgendes ein:
charge.succeeded, charge.updated. - Klicken Sie auf Endpunkt hinzufügen.
- Verwenden Sie den Webhook-Geheimschlüssel für die Umgebungsvariable
STRIPE_OPERATOR_WEBHOOK_SECRET.
Benachrichtigungen
| 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 Connector 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. |
Siehe auch