Admin API Flows for Tech Partners

Admin API endpoints flow for Interactions API Sources

Interactions API sources will receive an email when there's a newly provisioned Interactions API Key available for use. Below is a flow chart of Admin API endpoints a Source would use to access the new Interactions API Key and retrieve the secret.

Admin API endpoints flow for Interactions API Sources needing to add an external API Key (example: VAN API Key)

Interactions API Keys with VAN as a Destination require a VAN API Key. If the Interactions API Key is provisioned via API, the VAN API key can be added by the provisioned key Source.

If a data owner uses the DDx API Console to provision an Interactions API Keys with VAN as a Destination, the VAN API Key must be provided by the data owner in the Console upon creating the Interactions API Key.

Below is a flow chart of Admin API endpoints a Source would use to add a VAN API Key, and access the Interactions API Key secret.