Gain developer and user access for Experience Platform

Before creating integrations on Adobe Developer Console, your account must have developer and user permissions for an Experience Platform product profile in Adobe Admin Console.

Gain developer access

Contact an Admin Console administrator in your organization to add you as a developer to an Experience Platform product profile. See the Admin Console documentation for specific instructions on how to manage developer access for product profiles.

Once you are assigned as a developer, you can start creating integrations in Adobe Developer Console. These integrations are a pipeline from external apps and services to Adobe APIs.

Gain user access

Your Admin Console administrator must also add you as a user to the same product profile. With user access, you can see in the UI the outcome of the API operations that you perform.

See the guide on managing user groups in Admin Console for more information.

Generate an API key (client ID) and organization ID

NOTE
If you are following this document from the Privacy Service API guide, you can now return to that guide to generate the access credentials unique to Privacy Service.

After you have been given developer and user access to Platform through Admin Console, the next step is to generate your {ORG_ID} and {API_KEY} credentials in Adobe Developer Console. These credentials only need to be generated once and can be reused in future Platform API calls.

TIP
Instead of going to Developer Console, you can get all the authentication credentials that you need to work with Platform APIs directly from the API reference documentation pages. Read more about the functionality.

Add Experience Platform to a project

Go to Adobe Developer Console and sign in with your Adobe ID. Next, follow the steps outlined in the tutorial on creating an empty project in the Adobe Developer Console documentation.

Once you have created a new project, select Add API on the Project Overview screen.

TIP
If you are provisioned for several organizations, use the organization selector in the upper right corner of the interface to make sure that you are in the organization you need.

Developer Console screen with the Add API option highlighted.

The Add an API screen appears. Select the product icon for Adobe Experience Platform, then choose Experience Platform API before selecting Next.

Select Experience Platform API in the Add an API screen.

TIP
Select the View docs option to navigate in a separate browser window to the complete Experience Platform API reference documentation.

Select the OAuth Server-to-Server authentication type

Next, select the OAuth Server-to-Server authentication type to generate access tokens and access the Experience Platform API. Give your credential a meaningful name in the Credential name text field before selecting Next.

IMPORTANT
The OAuth Server-to-Server method is the only token generation method supported moving forward. The formerly supported Service Account (JWT) method is deprecated and cannot be selected for new integrations. While existing integrations using the JWT authentication method will continue to work until June 30th, 2025, Adobe strongly recommends that you migrate existing integrations to the new OAuth Server-to-Server method before that date. Get more information in the section Deprecated Generate a JSON Web Token (JWT).

Select the OAuth Server-to-Server authentication method for the Experience Platform API.

Select the product profiles for your integration

In the Configure API screen, select AEP-Default-All-Users along with any additional product profiles you wish to gain access to.

IMPORTANT
To get access to certain features in Platform, you also need a system administrator to grant you the necessary attribute-based access control permissions. Read more in the section Get the necessary attribute-based access control permissions.

Select product profiles for your integration.

Select Save configured API when you are ready.

A walkthrough of the steps described above to set up an integration with the Experience Platform API is also available in the video tutorial below:

Gather credentials

Once the API has been added to the project, the OAuth Server-to-Server page for the project displays the following credentials that are required in all calls to Experience Platform APIs:

Integration information after adding an API in Developer Consle.

  • {API_KEY} (Client ID)
  • {ORG_ID} (Organization ID)

Generate an access token

The next step is to generate an {ACCESS_TOKEN} credential for use in Platform API calls. Unlike the values for {API_KEY} and {ORG_ID}, a new token must be generated every 24 hours to continue using Platform APIs. Select Generate access token which produces your access token, as shown below.

Show how to generate access token

TIP
You can also use a Postman environment and collection to generate access tokens. For more information, read the section about using Postman to authenticate and test API calls.