Getting Started with the Ecomdash API

The ecomdash API can be used to automate the movement of data in and out of ecomdash for many of our features. Here is a link to our API documentation: https://ecomdash.portal.azure-api.net/

To use the ecomdash API, developers will need to register on the link above to create a developer account to gain access to our API. First, click 'Sign In' to sign up for Developer Access.

Once signed in, navigate to Products and 'Subscribe' to the ecomdash API. Subscribing will generate an Ocp-Apim-Subscription-Key. This key is accessible within your developer account under Products > Product Access. It is referenced in the API documentation as: Ocp-Apim-Subscription-Key and needs to be passed in with all API calls to identify the developer.

To access a specific ecomdash account using the API, you'll need to pass in the API key for the account you are attempting to access. This is known as ecd-subscription-key within the API documentation and also needs to be passed in on the header of all API calls.

The ecd-subscription-key can be found within your ecomdash account by navigating to Settings > Integrations & Tools > App Store > All Available Apps > Subscribe to the free Mobile/API Key App. The app will now appear in your My Apps tab where you can launch it. You will see a mobile / API key that you can generate.

Both the Ocp-Apim-Subscription-Key and ecd-subscription-key need to be established and passed in to the API for calls to be made.