Configuring the Mirakl Connector

    Learn how to configure the Stripe Mirakl Connector before installing it.

    Stripe webhook

    The connector requires the creation of a webhook endpoint to receive notification of account.updated events.

    1. Go to your webhook settings.

    2. Add a webhook endpoint for Connect applications.

    3. Record the signing secret. You will need it below.

    Mirakl custom field

    You must create a Shop Custom Field to use the connector. This field provides the onboarding URL to the seller. After the onboarding completes, the same field updates with a login URL.

    1. Log in your Mirakl back office as an Operator.
    2. Visit Settings > Advanced Parameters > Shops.
    3. Go to the Custom Fields tab.
    4. Use the following values to create a new field:
    Parameter Description
    Code By default, we require the code to be set to stripe-url. You can change that value if you also update MIRAKL_CUSTOM_FIELD_CODE in your .env file.
    Type Link
    Shops permissions Read only
    Required field No

    Configuration file

    1. Download the .env.dist file sample from our repository.

    2. Rename the file to .env and edit the variables documented below.

    Parameter Description
    APP_SECRET To be generated. Learn more on the Symfony documentation.
    BASE_HOST The base host the connector will be publicly available on. Used to generate the redirect URL during the sellers onboarding. E.g., stripe-mirakl.domain.com.
    DATABASE_URL The connection URL to your database. Learn more on the Doctrine documentation. E.g., pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8.
    MESSENGER_TRANSPORT_DSN The transport used for the queuing system.
    See the Symfony Messenger documentation for supported transports. E.g., amqp://guest:guest@localhost:5672/%2f/messages. Defaults to doctrine://default.
    MAILER_DSN The entire Symfony Mailer configuration using a DSN-like URL format. Learn more on the Symfony documentation. E.g., smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login. Defaults to smtp://null (mailer disabled).
    TECHNICAL_ALERT_EMAIL
    optional
    The email that will receive all technical alerts. E.g., myemail@domain.com. Defaults to empty. Required if mailer is enabled per MAILER_DSN.
    TECHNICAL_ALERT_EMAIL_FROM
    optional
    The email that will send all technical emails. Defaults to empty, required if mailer is configured. E.g, noreply@domain.com.
    STRIPE_CLIENT_ID Your Stripe Connect client_id. Available in your Connect settings.
    STRIPE_CLIENT_SECRET Your Stripe API secret key available in your Developers section.
    STRIPE_WEBHOOK_SECRET Your Stripe webhook secret available in your Connect webhook settings.
    ENABLES_AUTOMATIC_TRANSFER_CREATION
    optional
    Enable the automatic transfer creation for Mirakl Orders. See Mirakl Payments. Defaults to false.
    OPERATOR_PASSWORD
    optional
    To be generated so you can securely call the API endpoints exposed by the API. Set the X-AUTH-TOKEN header to this value.
    OPERATOR_NOTIFICATION_URL
    optional
    The endpoint on your server set to receive notifications from the connector. Defaults to empty (notifications disabled).
    MAIL_ON_NOTIFICATION_ENDPOINT_DOWN
    optional
    Enable alerts via email if a URL is provided in OPERATOR_NOTIFICATION_URL and that URL is not available or responds with an error. Defaults to true.
    MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWN
    optional
    Time between each alert via email. Use 0 to disable throttling. The maximum value depends on the notification worker maximum life, i.e., 3600 by default. Defaults to 10.
    MIRAKL_HOST_NAME Host name of your Mirakl Instance. Will be used as base for all Mirakl API calls. E.g., https://mymarketplace.mirakl.net.
    MIRAKL_API_KEY The Mirakl Operator key. Can be generated as a Mirakl Operator in your API settings. We recommend creating a specific Operator for the connector.
    MIRAKL_CUSTOM_FIELD_CODE
    optional
    Code of the custom field of type Link which will receive Stripe Express URLs. Defaults to stripe-url.
    REDIRECT_ONBOARDING
    optional
    The connector redirects the seller to this URL after completing his account creation on Stripe. Defaults to $MIRAKL_HOST_NAME/mmp/shop/account/shop.

    Next step

    Was this page helpful?

    Feedback about this page?

    Thank you for helping improve Stripe's documentation. If you need help or have any questions, please consider contacting support.

    On this page