Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Stripe health alertsBuilding with LLMsStripe for Visual Studio CodeFile uploads
Security
Security
Extend Stripe
Stripe Apps
Stripe Connectors
    Overview
    Integrate a connector
    Commercetools
    Adobe Commerce
    Mirakl
      Installation
      Configuration
      Onboarding sellers
      Payments
      Payouts
      Reference
    NetSuite
    Oracle Opera
    Cegid
    PrestaShop
    Salesforce
    SAP
    Shopware 6
    Stripe Tax for WooCommerce
    Stripe Tax for BigCommerce
    Partner connectors
    Build your own connector
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsStripe ConnectorsMirakl

Mirakl Connector installation

Install and validate the Miraki connector for Stripe.

Copy page

Requirements

Installing and running the application requires the following:

  • PHP 7.3+
  • PostgreSQL
  • A web server, Nginx recommended
  • A valid SSL/TLS certificate
  • Supervisord or equivalent
  • Crontab or equivalent

Install using Docker

You can build and start the application by embedding it in a container. See our Docker sample for more information.

Install manually

  1. Install Composer.
  2. Clone or download the Mirakl Connector from GitHub.
  3. Move the content to your web server directory, for example, /var/www.
  4. Download dependencies:
Command Line
composer install --prefer-dist --no-dev
  1. Make sure you properly configured the .env file.
  2. Run the migrations to set up the database:
Command Line
bin/console doctrine:migration:migrate --no-interaction

If you encounter any errors at this stage, check the DATABASE_URL variable in your .env file.

  1. Update your supervisor to automatically start and restart the workers.

A configuration example is available in our Docker sample. You can skip this step in a development environment and start the workers manually when needed, for example:

Command Line
php bin/console messenger:consume process_transfers --time-limit=3600 --env=prod
  1. Update your job scheduler to run the commands periodically.

A configuration example is available in our Docker sample. You can skip this step in a development environment and start the jobs manually when needed, for example:

Command Line
php bin/console connector:dispatch:process-transfer -q 2>&1
  1. Make sure that your web server is configured to use the public directory as document root.

Check your installation

Open your terminal and run the following command to confirm that your application is up and running correctly:

Command Line
curl -X GET "https://connector-url/api/mappings" \ -H "accept: application/json" \ -H "X-AUTH-TOKEN:
$OPERATOR_PASSWORD
"

You should get a 200 response code along with an empty payload.

Security

On your server, restrict all inbound traffic to the connector except for the following endpoints:

  • /api/public/onboarding/refresh

    Stripe redirects the seller to this URL to get a new onboarding link if it expires.

  • /api/public/webhook/operator

    Stripe notifies this endpoint when a payment is updated to map it with a Mirakl order within the connector.

  • /api/public/webhook/sellers

    Stripe notifies this endpoint when a Stripe account is updated to synchronize the seller’s status within the connector.

These endpoints are safe to expose, they each have an internal protection mechanism. Other endpoints are not safe to expose unless protected by a strong OPERATOR_PASSWORD.

See also

  • Integration steps.
Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc