Edit in GitHubLog an issue

Getting started with the CJA API

There are several steps to take before using the CJA APIs.

  • Permissions: Configure permissions for the developer in the Adobe Admin Console.
  • API Client: Create a client configuration in the Adobe I/O Console.
  • Authentication: Obtain the necessary credentials to send data to Adobe.

Permissions#

Before starting to use the CJA API, you must make sure that your account has the correct permissions to send requests. Even if you successfully authenticate with an Adobe ID, you cannot make requests to Adobe unless your account contains the correct organization permissions.

Give a developer correct API permissions as a product profile admin:

  1. Navigate to adminconsole.adobe.com.
  2. Check the organization name in the top right to make sure that you are logged in to the correct company.
  3. Click Products, then click Customer Journey Analytics.
  4. Select the desired product profile, or create a new product profile.
  5. Under the Permissions tab, assign the desired permissions to the product profile.
  6. Once the desired permissions are set, click the Developers tab.
  7. Click Add Developer, and enter the desired user's name or email address.
  8. Click Save.

See Managing developers in the Enterprise Admin user guide for more information.

API Client#

Once you are a developer for a CJA product profile, you can create an API client in the Adobe Developer Console.

  1. Navigate to console.adobe.io.

  2. Check the organization name in the top right to make sure that you are logged in to the correct company.

  3. Click Create new project.

  4. Click Add API.

  5. Click Customer Journey Analytics, then click Next.

  6. Click Generate Keypair.

    A config.zip file is automatically downloaded to your local machine. Keep this config folder in a secure location, as it contains your only copy of your private key. See JSON web token in the Adobe I/O Authentication user guide for more information.

  7. Click Next.

  8. Select the desired product profiles for the service account. Make sure that it contains the right permissions to access the API. Click Save configured API.

  9. Back on the project's home page, click Add to project > API.

  10. Click Adobe Experience Platform, then click Next.

  11. You already generated a keypair when creating the Adobe Analytics API, so you do not need to create another. Click Next.

  12. Select the desired product profiles for the service account. Make sure that it contains the right permissions to access the API. Click Save configured API.

Generate a JWT token and make an API call using the command line#

  1. Back on the project's home page, click Service Account (JWT) on the left, then click the Generate JWT tab.
  2. Open your config.zip file and locate your private key. Paste the private key in the Generate custom JWT field.
  3. Click Generate Token.
  4. Copy the sample cURL command to your clipboard.
  5. Open your operating system's Command Prompt or Terminal, then paste and execute the cURL command.
  6. Adobe's servers provide a response that includes an access_token. Copy this token to your clipboard.

You now have everything you need to start making API calls using the platform of your choice. See Use cases for examples on how to make API calls on different platforms.

Copyright © 2021 Adobe. All rights reserved.