Set Up for Sources
Instructions for how to get started with the Interactions API as a Source
The best and fastest way MIG communicates with Sources is via joint Slack channel so MIG can provide support with set up and management of connections to the Interactions API as a Source.
To create a joint Slack channel, please reach out to [email protected] with your organizational name and emails of individuals to be added as members of the channel.
Requesting and using a Sandbox Key
A Sandbox Key for the Interactions API allows you to test your setup to the Interactions API. Requests to the Interactions API with Sandbox Keys will not be forwarded to any destinations, but they will generate API status codes.
To request a Sandbox Key, reach out to MIG in your shared Slack channel. Once you have verified that your setup is working as intended, you can inform MIG that you are ready to send production traffic via the shared Slack group.
How to set up an Interactions API integration
The Interactions API receives requests at this URL: https://api.movementinfrastructure.org/v1/
Sending data to the Interactions API requires a valid API Key from a Data Owner. API requests must also be formatted in one of the Interactions API's accepted formats. The current version of the data formats the Interactions API accepts can be found here.
Source authenticates with the Interactions API via Basic Authentication headers. Sources may use any username they want, but must use their provisioned API Keys as the password/credentials.
Sending data to the Interactions API
MIG's Interactions API receives valid API requests, validates them, and delivers them to intended Destinations based on the properties of the API Key.
The MIG Interactions API is able to validate fields and objects in the main body of the request. The Interactions API also supports receiving a metadata_json field, which can contain additional fields not specified in specific API contracts. The Interactions API can receive individual objects or arrays of objects.
For more details on SLAs and replay needs, reach out to [email protected] or via joint Slack channel.
Use of the Interactions API
The use of API Keys
API Keys are production credentials that grant access to the Interactions API. Data owners (i.e., your users) should provide API Keys to you once they are ready for you to send data to their intended destinations. Data owners should also make sure to clarify which destinations are tied to a specific API Key.
API Keys correspond to one data owner, one source, and one to many destinations.
- Unless otherwise specified, requests that you send to the Interactions API will be delivered to all destinations associated with an API Key without any additional configurations needed in the request.
Sources will automatically receive responses from the Interactions API in the form of HTTP status codes.
- Sources will not automatically be notified if their data was successfully delivered to the destinations specified by an API Key. For more information on deliverability and feedback around successes and failures, Sources should request logs of their requests from MIG.
Usage Policies
MIG has developed policies around acceptable use of the Interactions API in order to make sure it can best serve the needs of all of its users. These policies govern MIG's approach to data security, rate limiting, data quality, volume, etc. The latest version of these policies will be shared with you as part of your onboarding.
Updated 11 days ago