Skip to main content

Authorization

Follow this guide to create a new Mirakl credential that will allow Nexla to authenticate to and exchange data with your Mirakl account.
mirakl_api_auth.png

Mirakl

Prerequisites​

Before creating a Mirakl credential, you need to obtain your API base URL and API key from your Mirakl account. Mirakl uses API key authentication for all API requests, with the API key sent in the Authorization header.

To obtain your Mirakl API credentials, follow these steps:

  1. Sign in to your Mirakl account using your administrator credentials.

  2. Navigate to the Settings or Administration section in your Mirakl dashboard.

  3. Look for the API or API Keys section in the settings menu.

  4. If you don't have an API key yet, click Generate API Key or Create API Key to create a new API key.

  5. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  6. Locate your API base URL in your Mirakl account settings or documentation. The API base URL is typically in the format https://[HOSTNAME] where [HOSTNAME] is your Mirakl instance hostname. The API base URL is used to construct API endpoint URLs for all Mirakl API requests.

  7. Store both the API key and API base URL securely, as you will need them to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization header for all API requests to the Mirakl API. The API base URL is used to construct API endpoint URLs specific to your Mirakl instance (e.g., https://[HOSTNAME]/api/sellerpayment/transactions_logs). The API key authenticates your requests and grants access to Mirakl resources based on your account permissions. If your API key is compromised, you should immediately revoke it in your Mirakl account settings and generate a new one. For detailed information about API authentication, available endpoints, and API usage, refer to the Mirakl API documentation.

Create a Mirakl Credential​

  • To create a new Mirakl credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Mirakl

MiraklCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

Mirakl uses API key authentication for all API requests. The API key is sent in the Authorization header to authenticate API requests to the Mirakl API.

  1. Enter your Mirakl API base URL in the API Base Url field. This should be the base URL of your Mirakl instance, typically in the format https://[HOSTNAME] where [HOSTNAME] is your Mirakl instance hostname. The API base URL is used to construct API endpoint URLs for all Mirakl API requests. Ensure the URL includes the protocol (https://) and does not include a trailing slash.

  2. Enter your Mirakl API key in the API Key field. This is the API key you obtained from your Mirakl account settings (Settings or Administration > API Keys). The API key is sent in the Authorization header for all API requests to the Mirakl API. The API key is sensitive information and must be kept confidential.

    Your Mirakl API base URL and API key can be found in your Mirakl account settings under the Settings or Administration > API Keys section. The API base URL is typically in the format https://[HOSTNAME] where [HOSTNAME] is your Mirakl instance hostname. The API key is sent in the Authorization header for all API requests to the Mirakl API.

    If your API key is compromised, you should immediately revoke it in your Mirakl account settings and generate a new one. The API key provides access to your Mirakl data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about API authentication, available endpoints, and API usage, see the Mirakl API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.