Getting Started with the Dataset Exchange API

Vendors and Tools submitting datasets through the Dataset Exchange API must create an App in the MIG Console in order to submit or retrieve datasets on behalf of themselves or their clients.

Once an App is created in the production environment and approved, Campaigns, Organizations, and Tools using the Dataset Exchange API will have the ability to view and "Connect" to your App. Connecting to an App grants permission to submit or retrieve datasets owned by the MIG User.

Each Dataset Exchange API user (Campaigns, Organizations, and Tools) is granted a "Workspace ID". This Workspace ID should be shared with any connected App in order to authenticate access to datasets. If you are testing or interacting with your own datasets, you should Connect to your own App in your Workspace. Non-production environment Apps are visible for connection only to their creator in their designated Workspace. Workspace ID is not a private value.

👍
Dataset Owners, Campaigns, and Organizations should Connect to an App to complete the process for using the Dataset Exchange API.

Creating An App

In order to get started you'll need to create a MIG account and create an "App" in the MIG Console:

Click + New App and select Dataset Exchange API from the dropdown menu

Create your Dataset Exchange API App. App Name, a short description, and the environment in which you plan to use the App are all required. Please note, if this is a production application, the name and description you write will be visible to other Movement Console users.

Select an App Type. These selections will not impact your access to or interactions with the Dataset Exchange API, they are only informational.

After your App has been successfully created, you can Generate a Private Key and view your App ID.

Private Keys

Private Keys should be generated in the MIG Console (see screenshot above) and stored securely.

Do not share your Private API Keys in publicly accessible areas such as GitHub, client-side code, etc. Workspace ID is not a private value.

To learn more about using your Private Keys and generating a system-level JSON Web Token, please visit the Authentication section.

👍
Dataset Owners, Campaigns, and Organizations should Connect to an App to complete the process for using the Dataset Exchange API