This page describes how to authenticate and start using Adobe Experience Platform Destination SDK. It includes instructions on how to obtain Adobe I/O authentication credentials, a sandbox name, and the destination authoring access control permission.
This guide uses Platform-specific concepts, such as organization and sandboxes. Consult the Experience Platform glossary for definitions of these terms. Consult the Destination SDK glossary for terms related directly to this functionality.
Destination SDK uses the Adobe I/O gateway for authentication. To make API calls to Destination SDK endpoints, you must provide certain headers in your API calls. Work with the Adobe Exchange team to set up authentication for you to the Adobe Developer Console.
To successfully make calls to Destination SDK API endpoints, follow the Experience Platform authentication tutorial. Start the tutorial from the “Generate an API key, organization ID, and client secret” step. The Adobe Exchange team will handle the previous steps for you. Completing the authentication tutorial provides the values for each of the required headers in Destination SDK API calls, as shown below:
x-api-key: {API_KEY}
, also referred to as Client IDx-gw-ims-org-id: {ORG_ID}
, also referred to as Organization IDAuthorization: Bearer {ACCESS_TOKEN}
. The access token has an expiration time of 24 hours, expressed in milliseconds, so you will have to refresh it. To refresh the access token, repeat the steps outlined in the authentication tutorial.All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Destination SDK require headers that specify the name of the sandbox the operation takes place in:
x-sandbox-name: {SANDBOX_NAME}
The Adobe Exchange team provides you with your sandbox name, which you are required to use in calls to the Destination SDK API endpoints.
To use the Destination SDK API endpoints described in the reference documentation, you need the Destination Authoring access control permission. Work with the Adobe Exchange team to get this permission assigned to you in Adobe Admin Console.
For more information, read the following Experience Platform Access Control documents:
By following the steps in this article, you obtained authentication credentials to Adobe I/O, a sandbox name, and the destination authoring access control permission. Next, you can set up a destination using Destination SDK.
Read the following configuration guides, depending on your destination type:
For all operations, refer to the Destination Authoring API documentation.
Use the Destination Authoring API Postman collection to configure your destination using the Destination SDK API endpoints. To get started with Postman, see the steps for importing environments and collections and a video guide for creating the Postman environment.