AEM OpenAPI Setup

1. Go to adminconsole.adobe.com and switch to the customer’s IMS org.
2. Products → Cloud Manager → add the customer’s admin to the Business Owner – Cloud Service profile.
3. Open Cloud Manager, find the AEM environment, and click ⋮ → Add product profiles.
4. Wait a few minutes, then refresh.

• AEM Administrators - author - Program {ID} - Environment {ID}
• AEM Sites Content Managers - author - Program {ID} - Environment {ID}
• AEM Assets Collaborator Users - author - Program {ID} - Environment {ID}

1. Go to developer.adobe.com and sign in with the customer’s IMS org.
2. Rename the project to something recognizable (e.g. Sites OpenAPI or <Customer> AEM OpenAPI). The auto-generated short name is the internal ID.

1. Click Add to Project → API, search for the product name, then click Next.
2. For Authentication type, select OAuth Server-to-Server.
   Do not pick the deprecated JWT flow. Adobe Service Account (JWT) credentials reached end of life on June 30, 2025, and remaining JWT credentials will stop working by March 1, 2026. All new integrations must use OAuth Server-to-Server.
3. The first API you add creates the credential. Subsequent APIs attach to the same credential — one credential, multiple APIs is the correct result.
4. For Select Product Profile, picking AEM Administrators - author - … is the simplest path for initial setup. You can tighten this in Step 3.
5. Click Next → Save configured API.

• Credential = who is calling (the OAuth S2S credential from Step 2)
• Product profile = what they can do in AEM (backed by an AEM system user with predefined ACLs)

1. In Admin Console → Products → Adobe Experience Manager as a Cloud Service.
2. Pick the environment (e.g. Customer AEM Sandbox - author). Repeat for every environment you want OpenAPI active in.
3. Pick the profile: AEM Administrators - author - Program {ID} - Environment {ID}.
4. Click the API Credentials tab → Add API Credential.
5. Find your project (e.g. Sites OpenAPI) and save.

• Read + write on /content/launches
• Read + write on the CF folders under /content/dam/<site>
• Execute on any workflow models triggered by API operations

<aem-project-repo>/
  config/
    api.yaml      ← THIS FILE
  ui.apps/
  ui.config/
  ui.content/

kind: "API"
version: "1.0"
metadata:
  envTypes: ["dev", "stage", "prod"]
data:
  allowedClientIDs:
    author:
      - "<Client ID from Developer Console>"

data:
  allowedClientIDs:
    author:
      - "ca2832e8724e47d58572f43dfaf98fd2"   # dev
      - "a56f38c740bb41a1aa6041d3aab65d2a"   # stage
      - "d47a542ced4f4b7db5ef7d6226f1c99d"   # prod

• kind must be "API", version must be "1.0"
• metadata.envTypes controls which environments this applies to
• Only add publish or preview keys if you are using the CF Delivery API on those tiers — for CF management and Launches, author only is correct
• The Client ID is the long hex string from the Developer Console credential page — not the IMS Org ID and not the technical account email

1. Cloud Manager → Pipelines → Add Pipeline.
2. Select Non-Production (dev / stage) or Production pipeline type.
3. Set the pipeline type to Deploy Configuration (not Fullstack, not Web Tier).
4. Point it at the same Git repo and the branch where you committed config/api.yaml.
5. Set Repository path to /.
6. Save and run the pipeline.

• The AEM OpenAPI integration option — makes the Add Integration → AEM OpenAPI button appear in Settings
• The CF Launches routing — tells Gradial to route Content Fragment edits through the OpenAPI Launches path instead of writing directly to master

1. Fill in the form:

3. Click Validate. Gradial performs a token-exchange dry run and hits the AEM endpoint. A green tick means credentials work.
4. Click Save.

• Trailing slash on one row but not the other
• Vanity domain on one row, *.adobeaemcloud.com on the other
• HTTP vs HTTPS
• Different casing

1. Settings → Integrations → click the classic aem row to edit it.
2. Under the General tab, find Content Fragments Workflow.
3. Select Staging Variation.
4. Save.

“What’s the active CF workflow for this integration?”

{
  "mode": "variation",
  "openApiAvailable": true,
  "openApiRoutingEnabled": true,
  "recommendedPath": "cf-launches"
}

1. Live edit. Ask Grady: “Update the headline of [some CF] to [new value].” Grady will create a launch, poll until it materializes, apply the edit to the launch copy, and hand off for review.
2. AEM verification. Browse to /content/launches/{YYYY}/{MM}/{DD}/... in the AEM author UI — the launch should be there with the staged edit.
3. Promote. In Gradial’s artifact card for the launch, click Promote. Gradial calls POST /adobe/launches/{id}/promote then cleans up the launch. Verify the source CF on master reflects the edit and the launch root is gone.