Authenticate and access the Reactor API
- Topics:
- Tags
CREATED FOR:
- Developer
In order to use the Reactor API to create and manage Tags extensions, each request must include the following authentication headers:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
Accept: application/vnd.api+json;revision=1
Content-Type: application/vnd.api+json
This guide covers how to use the Adobe Developer Console to gather the values for each of these headers so you can start making calls to the Reactor API.
Gain developer access to Adobe Experience Platform
Before you can generate authentication values for the Reactor API, you must have developer access to Experience Platform. To gain developer access, follow the beginning steps in the Experience Platform authentication tutorial. Once you have completed the Gain User Access step, return to this tutorial to generate the credentials specific to the Reactor API.
Generate access credentials
Using Adobe Developer Console, you must generate the following three access credentials:
{ORG_ID}
{API_KEY}
{ACCESS_TOKEN}
Your organization’s ID ({ORG_ID}
) and API key ({API_KEY}
) can be reused in future API calls after they have been initially generated. However, your access token ({ACCESS_TOKEN}
) is temporary and must be regenerated every 24 hours.
The steps for generating these values are covered in detail below.
One-time setup
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 Developer Console documentation.
Once you have created a project, select Add API on the Project Overview screen.
The Add an API screen appears. Select Experience Platform Launch API from the list of available APIs before selecting Next.
Next, select the authentication type to generate access tokens and access the Experience Platform API.
Select Next to continue.
The next screen prompts you to select one or more product profiles to associate with the API integration.
Select the desired product profiles from the list, then select Save configured API to complete the API registration.
Gather credentials
Once the API has been added to the project, the Experience Platform API page for the project displays the following credentials that are required in all calls to Experience Platform APIs:
{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 Experience Platform API calls. Unlike the values for {API_KEY}
and {ORG_ID}
, a new token must be generated every 24 hours to continue using Experience Platform APIs.
You have two options to generate your access tokens, depending on your use case:
Generate access tokens manually
To manually generate a new {ACCESS_TOKEN}
, navigate to Credentials > OAuth Server-to-Server and select Generate access token, as shown below.
A new access token is generated, and a button to copy the token to your clipboard is provided. This value is used for the required Authorization header, and must be provided in the format Bearer {ACCESS_TOKEN}
.
Automate token generation
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 in the Experience Platform API authentication guide.
Test API credentials
By following the steps in this tutorial, you should have valid values for {ORG_ID}
, {API_KEY}
, and {ACCESS_TOKEN}
. You can now test these values by using them in a simple cURL request to the Reactor API.
Start by attempting to make an API call to list all companies.
Once you confirm that your access credentials are working, continue to explore the other API reference documentation to learn the API’s many capabilities.
Reading sample API calls
Each endpoint guide provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the getting started guide for Experience Platform APIs.
Next steps
Now that you understand what headers to use, you are ready to begin making calls to the Reactor API. Select one of the endpoint guides to get started: