AEM REST OpenAPI for Content Fragment Delivery

Last update: November 6, 2024

CREATED FOR:

  • Admin
  • Developer
IMPORTANT
This API is available through the Early Adopter Program.
To see the status, and how to apply if you are interested, check the Release Notes.

In Adobe Experience Manager (AEM) as a Cloud Service, the AEM REST OpenAPI for Content Fragment Delivery:

  • is a HTTP REST API on AEM Edge Delivery Services, designed to deliver structured content from Content Fragments in JSON format
  • offers a modern CDN integration that allows active content invalidation
  • focuses on content delivery (performance, scalability, CDN integration, optimized JSON control and output)
  • includes the ability to hydrate JSON for referenced fragments and assets

This API:

For full documentation see AEM Sites API Schemas - Content Fragments Delivery API (2024.07-experimental).

NOTE
See AEM APIs for Structured Content Delivery and Management for an overview of the various APIs available and comparison of some of the concepts involved.

Caching

AEM integrates with the AEM CDN Fastly. This means that JSON responses served on the publish tier are cached at the Fastly level.

Responses are then cached, based on predefined caching headers (cannot be configured):

  • Responses are cached for 5 minutes in the browser/client cache
    • max-age=300
  • Responses are cached for 1 hour on the CDN cache
    • s-maxage=3600
  • Stale content can be served while revalidating new requests for up to 1 hour
    • stale-while-revalidate=3600
  • Stale content can be served, by error, for up to 1 day
    • stale-on-error=86400

AEM also comes with active CDN cache invalidation. This means that whenever content is updated, or published, the corresponding JSON OpenAPI responses are automatically invalidated, via a soft purge request to Fastly. This allows you to see changes reflected in the JSON output, before the actual CDN cache age (s-maxage) is reached.