Configuration du connecteur Mirakl
Définissez vos variables d'intégration.
Avant d’installer le connecteur, préparez un fichier contenant les variables ci-dessous.
Notre référentiel contient un exemple de fichier de configuration que vous pouvez copier et rennomer .env.
Paramètres généraux
| Paramètre | Description |
|---|
| APP_SECRET | À générer. Sert généralement à ajouter une plus grande entropie aux opérations liées à la sécurité. Pour en savoir plus, consultez la documentation sur Symfony. |
| OPERATOR_PASSWORD | À générer. Sert à confirmer les requêtes vers l’API exposée par le connecteur. Attribuez cette valeur à l’en-tête X-AUTH-TOKEN lorsque vous appelez l’API. |
| DATABASE_URL | L’URL de connexion à votre base de données. Pour en savoir plus, consultez la documentation sur Doctrine. Par exemple, pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8. |
| MESSENGER_TRANSPORT_DSN | Le moyen d’acheminement utilisé pour le système de mise en file d’attente. Consultez la documentation sur Symfony Messenger pour connaître les moyens d’acheminement pris en charge. Par exemple, amqp://guest:guest@localhost:5672/%2f/messages. Sa valeur par défaut est doctrine://default. |
| STRIPE_CLIENT_SECRET | Votre clé secrète API Stripe est disponible dans vos paramètres des clés API. Nous vous recommandons de créer une clé API réservée au connecteur. Les clés à usage limité ne sont pas prises en charge. |
| MIRAKL_HOST_NAME | Nom d’hôte de votre instance Mirakl. Par exemple, https://mymarketplace.mirakl.net. |
| MIRAKL_API_KEY | La clé d’opérateur Mirakl, qui peut être générée en tant qu’opérateur Mirakl dans vos paramètres d’API. Nous vous recommandons de créer un opérateur réservé au connecteur. |
Inscription des utilisateurs
| Paramètre | Description |
|---|
| REDIRECT_ONBOARDING | Le connecteur redirige le vendeur vers cette URL une fois son compte créé dans Stripe. La valeur par défaut est $MIRAKL_HOST_NAME/mmp/shop/account/shop. |
| BASE_HOST | Le domaine du serveur qui héberge votre connecteur. Par exemple : stripe-mirakl.example.com. |
| SCHEME | Le schéma utilisé par votre hôte de base. Sa valeur par défaut est https. |
| STRIPE_SELLERS_WEBHOOK_SECRET | Votre clé secrète de webhook Stripe est disponible dans vos paramètres de webhook Connect lorsque vous ajoutez l’endpoint, voir ci-dessous. |
| MIRAKL_CUSTOM_FIELD_CODE | Code du champ personnalisé que vous devez ajouter, voir ci-dessous. Sa valeur par défaut est stripe-url. |
Ajouter un endpoint de webhook Stripe pour les comptes connectés
- Rendez-vous dans vos paramètres des webhooks.
- Ajoutez un endpoint de webhook.
- Définissez l’URL sur
<BASE_HOST>/api/public/webhook/sellers. - Sélectionnez Écouter des événements sur des comptes connectés.
- Ajoutez
account.updated aux Événements à envoyer : - Cliquez sur Ajouter un endpoint.
- Utilisez la clé secrète de webhook pour la variable d’environnement
STRIPE_SELLERS_WEBHOOK_SECRET.
Ajouter un champ personnalisé à vos boutiques Mirakl
- Connectez-vous à votre back-office Mirakl en tant qu’opérateur.
- Rendez-vous sur Settings > Advanced Parameters > Shops.
- Rendez-vous dans l’onglet Custom Fields.
- Créez un nouveau champ à l’aide des valeurs suivantes :
| Paramètre | Description |
|---|
| Code | Utilisez stripe-url, sauf si vous choisissez une clé différente dans votre fichier d’environnement. |
| Type | Link |
| Autorisations des boutiques | Read only |
| Champ obligatoire | No |
Paiements
| Paramètre | Description |
|---|
| PAYMENT_METADATA_COMMERCIAL_ORDER_ID | Clé de métadonnées utilisée dans Charges pour transférer l’identifiant de commande commerciale Mirakl, et dont la valeur par défaut est mirakl_commercial_order_id. |
| ENABLE_PRODUCT_PAYMENT_SPLIT | Activez le flux de fractionnement des paiements pour les commandes de produits. Sa valeur par défaut est false. |
| ENABLE_SERVICE_PAYMENT_SPLIT | Activez le flux de fractionnement des paiements pour les commandes de services. Sa valeur par défaut est false. |
| ENABLE_PRODUCT_PAYMENT_REFUND | Activez le flux de remboursement des paiements pour les commandes de produits. Sa valeur par défaut est false. |
| ENABLE_SERVICE_PAYMENT_REFUND | Activez le flux de remboursement des paiements pour les commandes de services. Sa valeur par défaut est false. |
| STRIPE_OPERATOR_WEBHOOK_SECRET | Votre clé secrète de webhook Stripe est disponible dans vos paramètres de webhook de compte lorsque vous ajoutez l’endpoint, voir ci-dessous. |
Ajouter un endpoint de webhook Stripe pour votre compte
- Rendez-vous dans vos paramètres des webhooks.
- Ajoutez un endpoint de webhook pour votre compte.
- Définissez l’URL sur
<BASE_HOST>/api/public/webhook/operator. - Ajoutez ce qui suit aux Événements à envoyer:
charge.succeeded, charge.updated. - Cliquez sur Ajouter un endpoint.
- Utilisez la clé secrète de webhook pour la variable d’environnement
STRIPE_OPERATOR_WEBHOOK_SECRET.
Notifications et alertes
| Paramètre | Description |
|---|
| MAILER_DSN | L’ensemble de la configuration Symfony Mailer qui utilise un format d’URL de type DSN. Pour en savoir plus, consultez la documentation sur Symfony. Par exemple, smtp://user:pass@host:port. Sa valeur par défaut est smtp://null (expéditeur désactivé) |
| TECHNICAL_ALERT_EMAIL | Le destinataire des alertes techniques. Par exemple, myemail@example.com. Sa valeur par défaut est nulle. Obligatoire si l’expéditeur est activé en vertu de MAILER_DSN. |
| TECHNICAL_ALERT_EMAIL_FROM | L’expéditeur de tous les e-mails techniques. Sa valeur par défaut est nulle. Obligatoire si l’expéditeur est configuré. Par exemple : noreply@example.com. |
| OPERATOR_NOTIFICATION_URL | L’endpoint de votre serveur qui est configuré pour recevoir des notifications du connecteur. Sa valeur par défaut est nulle (notifications désactivées). |
| MAIL_ON_NOTIFICATION_ENDPOINT_DOWN | Activer les alertes par e-mail si une URL figure dans OPERATOR_NOTIFICATION_URL et que cette URL n’est pas disponible ou renvoie une erreur. Sa valeur par défaut est true. |
| MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN | Intervalle entre chaque envoi d’alerte par e-mail. Saisissez 0 pour désactiver la limite. La valeur maximum dépend de la durée de vie maximale du traitement des notifications, qui est de 3600 par défaut. Sa valeur est fixée à 10 par défaut. |
Voir aussi