AEM Content Fragment Delivery with OpenAPI aem-content-fragment-delivery-with-openapi

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

  • är ett OpenAPI som är optimerat för direktleverans av AEM Content Fragments i JSON-format.
  • erbjuder en modern CDN-integrering som tillåter att aktivt innehåll ogiltigförklaras
  • fokuserar på innehållsleverans (prestanda, skalbarhet, CDN-integrering, optimerad JSON-kontroll och utdata)
  • inkluderar möjlighet att hydratisera JSON för refererade fragment och resurser

Detta API:

Fullständig dokumentation finns i AEM Content Fragment Delivery with OpenAPI.

NOTE
Se AEM API:er för leverans och hantering av strukturerat innehåll för en översikt över de olika tillgängliga API:erna och en jämförelse av några av de koncept som ingår.
IMPORTANT
Om du vill aktivera Content Fragment Delivery med OpenAPI i AEM as a Cloud Service måste du kontrollera att det inte redan är aktiverat och sedan skicka en Adobe Support-biljett med titeln Enable Content Fragment Delivery with OpenAPI och ange:
  • Cloud Service program- och miljö-ID:n
  • information om det användningsfall du vill lösa med Content Fragment Delivery OpenAPI
  • information om alla dina kontakter som Adobe ska svara på och hålla dig informerad om begäran och projektet (om det behövs)

Cachning caching

AEM kan integreras med AEM CDN snabbt. Det innebär att JSON-svar som hanteras på publiceringsnivån cachelagras på snabbnivå.

Svaren cachelagras sedan baserat på fördefinierade cache-huvuden (kan inte konfigureras):

  • Svaren cachelagras i 5 minuter i webbläsarens/klientens cache
    • max-age=300
  • Svaren cachelagras i 1 timme i CDN-cachen
    • s-maxage=3600
  • Inaktuellt innehåll kan hanteras samtidigt som nya begäranden valideras i upp till en timme
    • stale-while-revalidate=3600
  • Inaktuellt innehåll kan hanteras av misstag i upp till 1 dag
    • stale-on-error=86400

Content Fragment Delivery med OpenAPI har stöd för aktiv CDN-cacheogiltigförklaring. Det innebär att när innehåll uppdateras, eller publiceras, blir motsvarande JSON OpenAPI-svar automatiskt ogiltiga, via en begäran om mjuk tömning till Fast. Detta gör att du kan se ändringar som återspeglas i JSON-utdata innan den faktiska CDN-cacheåldern (s-maxage) nås.

Tillgänglighet availability

Content Fragment Delivery with OpenAPI är tillgängligt på nivåerna Förhandsgranska och Publicera. OpenAPI innehåller innehållsfragment i JSON-format, både för förhandsgranskning och direktleverans.

Förhandsgranska Content Fragment Delivery with OpenAPI:

  • publicera till Förhandsgranska
  • aktivera åtkomst till förhandsgranskning med IP tillåtelselista
  • hämta URL:en för förhandsgranskning

CORS cors

CORS tillåtna ursprung definierar de ursprung som kan anropa API:t.

CORS tillåtna ursprung som definieras på dispatcherkonfigurationssidan, speciellt för GraphQL, beaktas inte av detta API.

Gränsvärden för API-hastighet api-rate-limits

API:t tillåter nya begäranden med en hastighet av upp till 200 begäranden per sekund och miljö.

När gränsen har överskridits börjar API:t skicka 429-felsvar. Dessa fel måste hanteras av alla klientprogram, och misslyckade begäranden som försöks igen efter ett exponentiellt fel. HTTP-svaret innehåller ett specifikt huvud, Retry-After, som anger för klienten hur lång tid de måste vänta innan begäran skickas igen.

Autentiserade begäranden authenticated-requests

Stöd för autentiserade begäranden kan implementeras med Edge-nyckeln AEM CDN. Med AEM CDN Edge-tangenten kan du förlita dig på AEM CDN och se till att endast specifika begäranden har åtkomst till API:t, baserat på den angivna Edge-nyckelrubriken.

NOTE
Auktorisering baserat på databasspecifika ACL:er stöds för närvarande inte.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab