ÃÛ¶¹ÊÓƵ

DocumentationAEMAEM TutorialsAEM as a Cloud Service Tutorials

Set up OpenAPI-based AEM APIs

Last update: Mon Mar 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Beginner
  • Developer
  • Leader

Learn how to set up your AEM as a Cloud Service environment to enable access to the OpenAPI-based AEM APIs.

AVAILABILITY
OpenAPI-based AEM APIs are available as part of an early access program. If you are interested in accessing them, we encourage you to email aem-apis@adobe.com with a description of your use case.

The high-level set up process involves the following steps:

  1. Modernization of AEM as a Cloud Service environment.
  2. Enable AEM APIs access.
  3. Create ÃÛ¶¹ÊÓƵ Developer Console (ADC) Project.
  4. Configure ADC Project
  5. Configure the AEM instance to enable ADC Project communication.

Modernization of AEM as a Cloud Service environment

The modernization of AEM as a Cloud Service environment is a one-time per environment activity that involves the following steps:

  • Update to the AEM Release 2024.10.18459.20241031T210302Z or later.
  • Add new Product Profiles to it, if environment was created before the release 2024.10.18459.20241031T210302Z.

Update AEM instance

To update the AEM instance, in the ÃÛ¶¹ÊÓƵ ’s Environments section, select the ellipsis icon next to the environment name and select Update option.

Update AEM instance

Then click the Submit button and run the suggested Fullstack Pipeline.

Select latest AEM release version

In my case, the Fullstack Pipeline is named Dev :: Fullstack-Deploy, and the AEM environment is called wknd-program-dev. Your names may be different.

Add new Product Profiles

To add new Product Profiles to the AEM instance, in the ÃÛ¶¹ÊÓƵ ’s Environments section, select the ellipsis icon next to the environment name and select the Add Product Profiles option.

Add new Product Profiles

You can review the newly added Product Profiles by clicking on the ellipsis icon next to the environment name and selecting Manage Access > Author Profiles.

The Admin Console window displays the newly added Product Profiles.

Review new Product Profiles

The above steps complete the modernization of the AEM as a Cloud Service environment.

Enable AEM APIs access

The presence of the new Product Profiles enable OpenAPI-based AEM API access in the ÃÛ¶¹ÊÓƵ Developer Console (ADC). Recall that ÃÛ¶¹ÊÓƵ Developer Console (ADC) is the developer hub for accessing ÃÛ¶¹ÊÓƵ APIs, SDKs, real-time events, serverless functions, and more.

The newly added Product Profiles are associated with the Services that represent AEM user groups with predefined Access Control Lists (ACLs).
The Services are used to control the level of access to the AEM APIs.

You can also select or deselect the Services associated with the Product Profile to reduce or increase the level of access.

Review the association by clicking on the View Details icon next to the Product Profile name.

Review services associated with Product Profile

By default, the AEM Assets API Users Service is not associated with any Product Profile. Let’s associate it with the newly added AEM Assets Collaborator Users - author - Program XXX - Environment XXX Product Profile. After this association, the ADC Project’s Asset Author API can setup the desired authentication and associate the authentication account with the Product Profile.

Associate AEM Assets API Users Service with Product Profile

Create ÃÛ¶¹ÊÓƵ Developer Console (ADC) Project

The ADC Project is used to add the desired APIs, set up its authentication, and associate the authentication account with the Product Profile.

To create an ADC Project:

  1. Login to the using your ÃÛ¶¹ÊÓƵ ID.

    ÃÛ¶¹ÊÓƵ Developer Console

  2. From the Quick Start section, click on the Create new project button.

    Create new project

  3. It creates a new project with the default name.

    New project created

  4. Edit the project name by clicking the Edit project button in the top right corner. Provide a meaningful name and click Save.

    Edit project name

Configure ADC Project

After creating the ADC Project, you have to add the desired AEM APIs, set up its authentication, and associate the authentication account with the Product Profile.

  1. To add AEM APIs, click on the Add API button.

    Add API

  2. In the Add API dialog, filter by Experience Cloud and select the desired AEM API. For example, in this case, the Asset Author API is selected.

    Add AEM API

  3. Next, in the Configure API dialog, select the desired authentication option. For example, in this case, the Server-to-Server authentication option is selected.

    Select authentication

    The Server-to-Server authentication is ideal for backend services needing API access without user interaction. The Web App and Single Page App authentication options are suitable for applications needing API access on behalf of users. See Difference between OAuth Server-to-Server vs Web App vs Single Page App credentials for more information.

  4. If needed, you can rename the API for easier identification. For demo purposes, the default name is used.

    Rename credential

  5. In this case, the authentication method is OAuth Server-to-Server so you need to associate the authentication account with the Product Profile. Select the AEM Assets Collaborator Users - author - Program XXX - Environment XXX Product Profile and click Save.

    Select Product Profile

  6. Review the AEM API and authentication configuration.

    AEM API configuration

    Authentication configuration

If you choose the OAuth Web App or OAuth Single Page App authentication method, the Product Profile association is not prompted but application redirect URI is required. The application redirect URI is used to redirect the user to the application after authentication with an authorization code. The relevent use cases tutorials outline such authentication specific configurations.

Configure the AEM instance to enable ADC Project communication

To enable the ADC Project’s ClientID to communication with the AEM instance, you need to configure the AEM instance.

It is done by defining the API configuration in the config.yaml file of
the AEM Project and deploying it using the Config Pipeline in the Cloud Manager.

  1. In AEM Project, locate or create the config.yaml file from the config folder.

    Locate config YAML

  2. Add the following configuration to the config.yaml file.

    code language-yaml 
    kind: "API"
version: "1.0"
metadata:
    envTypes: ["dev", "stage", "prod"]
data:
    allowedClientIDs:
        author:
        - "<ADC Project's Credentials ClientID>"

    Replace <ADC Project's Credentials ClientID> with the actual ClientID of the ADC Project’s Credentials value. The API endpoint that is used in this tutorial is available only on the author tier, but for other APIs, the yaml config can also have a publish or preview node.

    note caution
    CAUTION
    For demo purposes, the same ClientID is used for all environments. It is recommended to use separate ClientID per environment (dev, stage, prod) for better security and control.

  3. Commit the config changes and push the changes to the remote Git repository the Cloud Manager pipeline is connected to.

  4. Deploy the above changes using the Config Pipeline in the Cloud Manager. Note that the config.yaml file can also be installed in an RDE, using command line tooling.

    Deploy config.yaml

Next steps

Once the AEM instance is configured to enable ADC Project communication, you can start using the OpenAPI-based AEM APIs. Learn how to use the OpenAPI-based AEM APIs using different OAuth authentication methods:

Invoke API using Server-to-Server authentication

Invoke API using Server-to-Server authentication

Learn how to invoke OpenAPI-based AEM APIs from a custom NodeJS application using OAuth Server-to-Server authentication.

Learn more

Invoke API using Web App authentication

Invoke API using Web App authentication

Learn how to invoke OpenAPI-based AEM APIs from a custom web application using OAuth Web App authentication.

Learn more

Invoke API using Single Page App authentication

Invoke API using Single Page App authentication

Learn how to invoke OpenAPI-based AEM APIs from a custom Single Page App (SPA) using OAuth 2.0 PKCE flow.

Learn more

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69