Getting Started with REST APIs getting-started-with-rest-apis

Adobe Developer Overview adobeio

Adobe Developer is Adobe’s developer ecosystem and community. It includes APIs for all Adobe products.

This is the recommended way of setting up and using Adobe APIs.

Prerequisites prerequisites

Before you can configure JWT authentication, make sure you have access to the Adobe Developer Console in Adobe Developer. Contact your organization administrator for access requests.

Authentication auth

Follow the steps below to configure JWT (Service Account) authentication using Adobe Developer:

1. Log in to the Adobe Developer Console.
2. Follow the steps in Service Account Connection.
   • During Step 2: Add an API to your project using Service Account authentication, choose the Audience Manager API option.
3. Try out the connection by making your first API call based on the instructions from Step 3.

Technical account RBAC permissions

If your Audience Manager account uses Role-based Access Control, you must create an Audience Manager technical user account and add it to the Audience Manager RBAC group that will make the API calls.

Follow the steps below to create a technical user account and add it to an RBAC group:

1. Make a GET call to https://aam.adobe.io/v1/users/self. The call will create a technical user account that you can see in the Admin Console, in the Users page.

   

2. Log in to your Audience Manager account and add the technical user account to the user group that will make the API calls.

The Audience Manager REST API follows OAuth 2.0 standards for token authentication and renewal. The sections below describe how to authenticate and start working with the APIs.

Create a Generic API User requirements

We recommend you create a separate, technical user account for working with the Audience Manager APIs. This is a generic account that is not tied to or associated with a specific user in your organization. This type of API user account helps you accomplish 2 things:

• Identify what service is calling the API (e.g., calls from your apps that use our APIs or from other tools that make API requests).
• Provide uninterrupted access to the APIs. An account tied to a specific person may be deleted when they leave your company. This will prevent you from working with the available API code. A generic account that’s not tied to a particular employee helps you avoid this problem.

As an example or use case for this type of account, let’s say you want to change a lot of segments at once with the Bulk Management Tools. Well, to do this, your user account needs API access. Rather than add permissions to a specific user, create a non-specific, API user account that has the appropriate credentials, key, and secret to make API calls. This is also useful if you develop your own applications that use the Audience Manager APIs.

Work with your Audience Manager consultant to set up a generic, API-only user account.

Password Authentication Workflow password-authentication-workflow

Password authentication secure access our REST API. The steps below outline the workflow for password authentication from a JSON client in your browser.

Step 1: Request API Access

Contact your Partner Solutions manager. They will provide you with an API client ID and secret. The ID and secret authenticate you to the API.

Note: If you’d like to receive a refresh token, specify that when you request API access.

Step 2: Request the Token

Pass in a token request with your preferred JSON client. When you build the request:

• Use a POST method to call https://api.demdex.com/oauth/token.
• Convert your client ID and secret to a base-64 encoded string. Separate the ID and secret with a colon during the conversion process. For example, the credentials testId : testSecret convert to dGVzdElkOnRlc3RTZWNyZXQ=.
• Pass in the HTTP headers Authorization:Basic <base-64 clientID:clientSecret> and Content-Type: application/x-www-form-urlencoded . For example, your header could look like this:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Set up the request body as follows:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Step 3: Receive the Token

The JSON response contains your access token. The response should look like this:

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

The expires_in key represents the number of seconds until the access token expires. As best practice, use short expiration times to limit exposure if the token is ever exposed.

Refresh Token refresh-token

Refresh tokens renew API access after the original token expires. If requested, the response JSON in the password workflow includes a refresh token. If you don’t receive a refresh token, create a new one through the password authentication process.

You can also use a refresh token to generate a new token before the existing access token expires.

If your access token has expired, you receive a 401 Status Code and the following header in the response:

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

The following steps outline the workflow for using a refresh token to create a new access token from a JSON client in your browser.

Step 1: Request the New Token

Pass in a refresh token request with your preferred JSON client. When you build the request:

• Use a POST method to call https://api.demdex.com/oauth/token.
• Convert your client ID and secret to a base-64 encoded string. Separate the ID and secret with a colon during the conversion process. For example, the credentials testId : testSecret convert to dGVzdElkOnRlc3RTZWNyZXQ=.
• Pass in the HTTP headers Authorization:Basic <base-64 clientID:clientSecret> and Content-Type: application/x-www-form-urlencoded. For example, your header could look like this:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• In the request body, specify the grant_type:refresh_token and pass in the refresh token you received in your previous access request. The request should look like this:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Step 2: Receive the New Token

The JSON response contains your new access token. The response should look like this:

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

Authorization Code and Implicit Authentication authentication-code-implicit

The Audience Manager REST API supports authorization code and implicit authentication. To use these access methods, your users need to log in to https://api.demdex.com/oauth/authorize to get access and refresh tokens.