> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/mirakl-prebuilt-connector.md).

# Mirakl (prebuilt connector)

## Description

**Mirakl** eCommerce software provides online marketplace software to retailers, manufacturers and wholesalers.

## API documentation

API documentation for **Mirakl** (used to build this connector) can be found via the link below:

{% embed url="<https://developer.mirakl.com/>" %}

## Authentication

When adding connector instances for **Mirakl**, the following authentication methods are supported:

* [Token authentication](#token-authentication)

### Token authentication

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **token** authentication, the credentials below are prompted:

<table><thead><tr><th width="193">Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>URL</code></td><td>true</td><td>Your Mirakl marketplace URL in full - for example:<br><code>https://patchworksintegrationsuk-dev.mirakl.net</code></td></tr><tr><td><code>Front key</code></td><td>true</td><td>This is the API key generated from the Mirakl dashboard (user settings).</td></tr></tbody></table>
