Mirakl provides two environments: one for testing and one for production. The endpoints of each environment are below.
Every REST call to Mirakl Connect and to Mirakl Account is served under the base path /api/channel-platform. The base URLs in the tables below already include it. Call them as they are written, and append the path of the operation after them.
Build and validate your connector against the test environment before you deploy to production. The partner team provisions your test account and its credentials, which keeps the test data separate from the production data. The test hosts mirror production on the *-test.mirakl.net domains listed in the TEST rows below.
The Mirakl Connect host serves most integrator operations: orders, returns, carriers and order documents, catalog configuration and taxonomy, and store business information.
| Stage | Mirakl Connect base URL |
|---|---|
| TEST | https://connectpartner-test.mirakl.net/api/channel-platform |
| PROD | https://miraklconnect.com/api/channel-platform |
The Mirakl Account host serves the account data of the channels, the sellers, the users, and the stores.
| Stage | Mirakl Account base URL |
|---|---|
| TEST | https://account-test.mirakl.net/api/channel-platform |
| PROD | https://account.mirakl.net/api/channel-platform |
The Mirakl Authentication System issues the OAuth2 access tokens that authenticate the REST calls. Your connector requests a token from this host with the client credentials Mirakl provides. For the full request flow, refer to Authorization.
| Stage | Token endpoint |
|---|---|
| TEST | https://auth-test.mirakl.net/oauth/token |
| PROD | https://auth.mirakl.net/oauth/token |
- Get access: the credentials and the identifiers the partner team provides for each environment.
- Authorization: how to request a token from the endpoint above.
- Calling the APIs: the base path, and how the calls split across the two hosts.