Configurer l'application Mirkal

Définissez vos variables d’intégration.

Before you install the Mirakl app, prepare a file with the variables outlined in this guide. To get started, you can copy our sample configuration file and rename to .env.

Paramètres généraux

Configurez les paramètres généraux de l’application :

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`	A générer. Utilisé pour sécuriser les requêtes à l’API exposée par le module d’extension. 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 de 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 module d’extension. 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. Elle 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 module d’extension.

Inscription des utilisateurs

Configurez les paramètres d’inscription des utilisateurs de l’application :

Paramètre	Description
`REDIRECT_ONBOARDING`	Le module d’extension redirige le marchand vers cette URL une fois son compte créé sur Stripe. La valeur par défaut est `$MIRAKL_HOST_NAME/mmp/shop/account/shop`.
`BASE_HOST`	Le domaine du serveur qui héberge votre module d’extension. Par exemple, `stripe-mirakl.example.com`.
`PROGRAMME`	Le schéma utilisé par votre hôte de base. Sa valeur par défaut est `https`.
`STRIPE_SELLERS_WEBHOOK_SECRET`	Your Stripe webhook secret available in your Connect webhook settings when adding the endpoint. See Add a Stripe webhook endpoint for connected accounts for details.
`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 point de terminaison de webhook Stripe pour les comptes connectés

Go to your webhook settings.
Ajoutez un point de terminaison web hook en cliquant sur le bouton Ajouter une destination.
Sélectionnez Comptes connectés dans les options Événements de et sélectionnez account.updated dans la liste des événements disponibles. Entrez la version de l’API Stripe souhaitée. Cliquez sur Continuer.
Sélectionnez Point de terminaison de l’accroche web dans la liste des types de destination disponibles. Cliquez sur Continuer.
Définissez l’URL du point de terminaison sur <BASE_HOST>/api/public/web hook/sellers et remplissez les autres champs comme vous le souhaitez.
Cliquez sur Créer une destination.
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 application administrative Mirakl en tant qu’opérateur.
Accédez à Paramètres > Paramètres avancés > Boutiques.
Allez dans Champs personnalisés.
Créez un nouveau champ en utilisant les valeurs qui suivent :

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	`Lecture seule`
Champ obligatoire	`No`

Paiements

Configurez les paramètres de paiement de l’application :

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`.
`NABLE_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`	Your Stripe webhook secret is available in your account event destination details page when adding the endpoint. See Add a Stripe webhook endpoint for your account for details.

Ajouter un point de terminaison de webhook Stripe pour votre compte

Go to your webhook settings.
Ajoutez un point de terminaison web hook en cliquant sur le bouton Ajouter une destination.
Sélectionnez Votre compte dans les options Événements de et sélectionnez charge.succeeded et charge.updated dans la liste des événements disponibles. Entrez la version de l’API Stripe souhaitée. Cliquez sur Continuer.
Sélectionnez Point de terminaison de l’accroche web dans la liste des types de destination disponibles. Cliquez sur Continuer.
Définissez l’URL du point de terminaison sur <BASE_HOST>/api/public/web hook/operator et remplissez les autres champs comme vous le souhaitez.
Cliquez sur Créer une destination.
Utilisez la clé secrète de webhook pour la variable d’environnement STRIPE_OPERATOR_WEBHOOK_SECRET.

Notifications et alertes

Configurez les paramètres de notification et d’alerte de l’application :

Paramètre	Description
`MAILER_DSN`	L’ensemble de la configuration de Symfony Mailer qui utilise un format d’URL de type DSN. Pour en savoir plus, consultez la documentation de 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é par `MAILER_DSN`.
`TECHNICAL_ALERT_EMAIL_FROM`	L’expéditeur de tous les courriels techniques. Sa valeur par défaut est nulle. Obligatoire si l’expéditeur est configuré. Par exemple : `noreply@example.com`.
`OPERATOR_NOTIFICATION_URL`	Le point de terminaison de votre serveur qui est configuré pour recevoir des notifications du module d’extension. Sa valeur par défaut est nulle (notifications désactivées).
`MAIL_ON_NOTIFICATION_ENDPOINT_DOWN`	Activez les alertes par courriel si une URL est fournie dans `OPERATOR_NOTIFICATION_URL` et que cette URL n’est pas disponible ou renvoie une erreur. La valeur par défaut est définie à `true`.
`MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN`	Intervalle entre chaque alerte par courriel. Utilisez `0` pour désactiver la limitation. La valeur maximale dépend de la durée de vie maximale du traitement des notifications, à savoir `3600`par défaut. La valeur par défaut est définie à `10`.