AEM Forms as a Cloud Service Communications Synchronous APIs Processing

Log into Adobe Cloud Manager

1. Navigate to my.cloudmanager.adobe.com
2. Log in with your Adobe ID

Navigate to the Program Overview

1. Select your program from the list. You are redirected to the Program Overview page

Locate Environment Details

1. Select the ellipsis(…) icon next to the environment name and click Update

2. Click the Submit button and run the suggested Fullstack Pipeline.

   

Locate the Repository Section

1. On the Program Overview page, click the Repositories tab

2. Locate the repository name and click on the ellipsis menu (…)

3. Copy the repository URL

   note note
   NOTE
   The URL format is typically https://git.cloudmanager.adobe.com/<org>/<program>/

Clone Using Git Command

1. Open the command prompt or terminal

2. Run the git clone command to clone the Git repository.

   code language-bash
   git clone [repository-url]

   note note
   NOTE
   To clone the Git repository use the credentials provided by Adobe Cloud Manager.

   For example, to clone your Git Repository, execute the following command:

   code language-bash
   https://git.cloudmanager.adobe.com/formsinternal01/AEMFormsInternal-ReleaseSanity-p43162-uk59167/

   

Log into Adobe Cloud Manager

1. Navigate to my.cloudmanager.adobe.com
2. Log in with your Adobe ID

Navigate to the Program Overview
Select your program from the list. You are redirected to the Program Overview page

Access and View AEM Cloud Service Environment

You can view or access the AEM Cloud Service Environment details using either of the two options:

• Option 1: From Overview Page

  1. On the Program Overview page

  2. Click “Environments” in the left side menu. You can see a list of all environments

     

  3. Click on the specific environment name to view details

     

• Option 2: From Environments Section

  1. On the Program Overview page

  2. Locate the Environments section

  3. Click “Show All” to view all environments

  4. Click the ellipsis menu (…) next to the environment
     

  5. Select “View Details”

     

Find Your AEM Forms Endpoint

From the Environment details page, note the following details:

Author Service URL

• URL: https://author-pXXXXX-eYYYYY.adobeaemcloud.com
• Bucket: author-pXXXXX-eYYYYY
  Example: https://author-p43162-e177398.adobeaemcloud.com

Publish Service URL

• URL: https://publish-pXXXXX-eYYYYY.adobeaemcloud.com
• Bucket: publish-pXXXXX-eYYYYY
  Example: https://publish-p43162-e177398.adobeaemcloud.com

Access Adobe Developer Console

1. Navigate to Adobe Developer Console
2. Log in with your Adobe ID

Create New Project

1. From the Quick Start section, click Create new project

2. A new project is created with a default name

   

3. Click Edit project in the top right corner

   

4. Provide a meaningful name (e.g., “formsproject”)

5. Click Save

   

Click Add API

Select Forms Communication APIs

1. In the Add API dialog, filter by Experience Cloud
2. Select “Forms Communication APIs”

Select OAuth Server-to-Server authentication method

Click Add API

• In your project, click the Add API button

Select AEM Forms Delivery and Runtime API

• In the Add API dialog, filter by Experience Cloud
• Select “AEM Forms Delivery and Runtime API”
• Click Next

Authentication Method

• Select OAuth Server-to-Server authentication method.

Select the appropriate Product Profile based on required access level:

Select the Product Profile that matches your Author Service URL (https://author-pXXXXX-eYYYYY.adobeaemcloud.com). For example: select https://author-pXXXXX-eYYYYY.adobeaemcloud.com.

Click Save configured API. The API and Product Profile are added to your project

Access Your Credentials

1. Navigate to your project in Adobe Developer Console
2. Click on OAuth Server-to-Server credential
3. View the Credential details section

Record API Credentials

API Credentials:
================
Client ID: <your_client_id>
Client Secret: <your_client_secret>
Technical Account ID: <tech_account_id>
Organization ID: <org_id>
Scopes: AdobeID,openid,read_organizations

Navigate to your Project

1. In Adobe Developer Console, open your project
2. Click OAuth Server-to-Server

Generate Access Token

1. Click the “Generate access token” button in your project’s API section
2. Copy the generated access token

Locate or Create Config Directory

1. Navigate to the cloned AEM Project repository, navigate to the config folder
2. If it doesn’t exist, create it at the project root level:

mkdir config

Create a new file named api.yaml in the config directory:

touch config/api.yaml

Add the following code in the api.yaml file:

kind: "API"
version: "1"
metadata:
envTypes: ["dev"]  # or ["prod", "stage"] for production environments
data:
allowedClientIDs:
    author:
    - "<your_client_id>"
    publish:
    - "<your_client_id>"
    preview:
    - "<your_client_id>"

The following explains the configuration parameters:

• kind: Always set to "API" (identifies this as an API configuration)

• version: API version, typically "1" or "1.0"

• envTypes: Array of environment types where this config applies

  • ["dev"] - Development environments only
  • ["stage"] - Staging environments only
  • ["prod"] - Production environments only

• allowedClientIDs: Client IDs allowed to access your AEM instance

  • author: Client IDs for author tier
  • publish: Client IDs for publish tier
  • preview: Client IDs for preview tier

For example, add the allowedClientIDs as 6bc4589785e246eda29a545d3ca55980 and envTypes as dev:

Commit and Push Changes

1. Navigate to root folder of your clonned repository and execute the below commands:

    git add config/api.yaml
    git commit -m "Whitelist client id for api invocation"
    git push origin <your-branch>

Setup Config Pipeline

1. Log into Cloud Manager

   1. Navigate to my.cloudmanager.adobe.com
   2. Log in with your Adobe ID

2. Navigate to Your Program
   Select your program from the list and you are redirected on the Program Overview page

3. Locate the Pipelines Card

   1. Locate the Pipelines card on the Program Overview page
   2. Click “Add” button

4. Select Pipeline Type

   • For Development Environments: Select “Add Non-Production Pipeline”. Non-production pipelines are for dev and stage environments

   • For Production Environments: Select “Add Production Pipeline”. Production pipelines require additional approvals

     note note
     NOTE
     In this case, create a Non-Production Pipeline since a development environment is available.

5. Configure Pipeline - Configuration Tab

   In the Configuration tab:

   a. Pipeline Type

   • Select “Deployment Pipeline”

   b. Pipeline Name

   • Provide a descriptive name, For example, name the pipeline as api-config-pipieline

   c. Deployment Trigger

   • Manual: Deploy only when manually triggered (recommended for initial setup)
   • On Git Changes: Auto-deploy when changes are pushed to the branch

   d. Important Metric Failures Behavior

   • Ask every time: Prompt for action on failures (default)
   • Fail Immediately: Automatically fail pipeline on metric failures
   • Continue Immediately: Continue despite failures

   e. Click “Continue” to proceed to the Source Code tab

   

6. Configure Pipeline - Source Code Tab

   In the Source Code tab:

   a. Deployment Type

   • Select “Targeted deployment”

   b. Deployment Options

   • Select “Config” (deploy configuration files only). It tells Cloud Manager this is a config deployment.

   c. Select Eligible Deployment Environment

   • Choose the environment where you want to deploy the config. In this case, it is a dev environment.

   d. Define Source Code Details

   • Repository: Select the repository containing your api.yaml file. For example, select the AEMFormsInternal-ReleaseSanity-p43162-uk59167 repository.
   • Git Branch: Select your branch. For example, in this case our code is deployed at the main branch.
   • Code Location: Enter the path to config directory. As theapi.yaml is in config folder at root, so enter /config

   e. Click “Save” to create the pipeline

   

Deploy Configuration

Now that the pipeline is created, deploy your api.yaml configuration:

1. From the Pipelines Overview

   1. On the Program Overview page, locate the Pipelines card
   2. Navigate to your newly created config pipeline in the list. For example, look for the pipeline name you created (e.g., “api-config-pipeline”). You can see pipeline details including status and last run.

2. Start the Deployment

   1. Click the “Build” button (or play icon ▶) next to your pipeline
   2. Confirm the deployment if prompted and the pipeline execution begins

   

3. Verify Successful Deployment

   • Wait for the pipeline to complete.

     • If it succeeds, the status changes to “Success” (green checkmark ✓).

     • If it fails, the status changes to “Fail” (red cross ✗). Click Download logs to view the error details.

       

   Now, you can start testing the Forms Communications APIs. For testing purposes, you can use the Postman, curl, or any other REST client to invoke the APIs.

Navigate to API Documentation

• Forms API: Forms API Reference
• Document Services: Document Services API Reference
  Open the Document Services APIs documentation in your browser.

Expand the Document Generation section and select Generates a fillable PDF form from an XDP or PDF template, optionally with data merging.

In the right pane, click Try it.

Enter the following values:

Click Send to invoke the API

Check the response in the Response tab:

• If the response code is 200, it means the PDF is created successfully.
• If the response code is 400, it means the request parameters are invalid or malformed.
• If the response code is 500, it means there is an internal server error.

In this case, the response code is 200, it means that the PDF is generated successfully:

Now, you can download the created PDF using the Download button and view it in PDF viewer:

Open the cmd/terminal and run the command:

code .

It opens the project in the code editor.

Update the package.json file to add the type to module.

{
"name": "demo-nodejs-generate-pdf",
"version": "1.0.0",
"type": "module",
"main": "index.js",
}

Create .env file at the root level of an project

Add the following configuration and replace the placeholders with the actual values from the ADC Project’s OAuth Server-to-Server credential.

CLIENT_ID=<ADC Project OAuth Server-to-Server credential ClientID>
CLIENT_SECRET=<ADC Project OAuth Server-to-Server credential Client Secret>
SCOPES=<ADC Project OAuth Server-to-Server credential Scopes>