Prerequisites

In order to successfully make calls to Experience Platform APIs, you must have the following:

  • An organization with access to Adobe Experience Platform.
  • An Admin Console administrator that is able to add you as a developer and a user for a product profile.
  • An Experience Platform system administrator who can grant you the necessary attribute based access controls to perform read or write operations on different parts of Experience Platform through APIs.

You must also have an Adobe ID to complete this tutorial. If you do not have an Adobe ID, you can create one using the following steps:

  1. Go to Adobe Developer Console.
  2. Select Create a new account.
  3. Complete the sign-up process.

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 Experience 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 Experience Platform API calls.

TIP
Instead of going to Developer Console, you can get all the authentication credentials that you need to work with Experience 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.