Configure a Mirakl Connector
The Mirakl Connector enables seamless integration and data synchronization between DJUST and a Mirakl-powered marketplace, via the Mirakl REST API. This Connector allows DJUST to retrieve product data, offers, and stock information directly from your Mirakl instance.
Prerequisites
Before configuring a Mirakl Connector, make sure you have the following:
- A valid Mirakl API URL
- Your Operator API Key
- Your Front-Office API Key
- (Optional) A language mapping strategy if you use multi-language fields
Configure a Mirakl Connector in DJUST
Create a Mirakl Connector
Step 1 – Access the Data Hub
- Go to the Data Hub page from the DJUST Back-Office
- Click on Configure a new Connector
- Select the Connector type and choose "Mirakl"
Step 2 – Configure Connection Settings
Fill in the following fields:
- Connection name (must be unique)
- API URL (e.g. https://operator.mirakl.net/api)
- Operator API Key
- Front-office API Key
Multi-language supportIf automatic mapping is disabled, you’ll need to define:
- A mapping key (used to match field values)
- The language for each field
Mandatory fieldsAll fields are required to save a Mirakl Connector.
Step 3 – Test and Save
- Each API key has its own test button, with a result displayed per key
- ✅ If both tests succeed, click Save to create the Connector
- ❌ If a test fails, check that key and the Mirakl API endpoint
API keys: masking and per-key testing
A Mirakl Connector carries two API keys — the Front-Office key and the Operator key. Both are handled as secrets.
Masked display
Both keys are displayed masked, like the password of an SFTP connector: ******* followed by the last three characters.
- Saving the connector without touching a key keeps the stored value. Only a new value typed in replaces it.
- The same rule applies to the Mirakl parameters of the marketplace.
Warning: On a Mirakl Connector, both keys remain mandatory. Leaving a field untouched preserves the stored key, but sending an explicitly empty string is rejected with a400.
Testing a key
Each key has its own test button and its own result.
| Case | What is tested |
|---|---|
| A key left untouched on an existing connector | The stored key and URL. You no longer need to know the key in clear text to check that it works. |
| A key newly typed in | The value you just entered. Unchanged behaviour. |
| The connector carries no key of the tested type — an older connector with no Operator key, for instance | The result says so explicitly (MISSING_KEY). |
Endpoint: POST /v1/mapper/client/{clientId}/mirakl/test-api-key · Access: dj-client: OPERATOR
{ "keyType": "FRONT_OFFICE" }keyType accepts FRONT_OFFICE or OPERATOR, and is the only field of the body — the stored key and URL of the connector are the ones tested.
Manage a Mirakl Connector
Once your Mirakl Connector is created, you can manage it from the Data Hub interface:
- Go to the Data Hub page
- Select the Connector tab
- Choose the Mirakl connection to modify
Update
- Edit the desired parameters
- Click Save to confirm the changes
Activate, Disable or Delete a Mirakl Connector
- Click More actions and select one of the following:
- Activate: to enable the connection
- Disable: to temporarily deactivate the Connector
- Delete. Click Delete and confirm to permanently remove the Connector (⚠️ This action is irreversible).
Updated 13 days ago

