通过 OpenAPI 进行 AEM 内容片段传递 aem-content-fragment-delivery-with-openapi

在Adobe Experience Manager (AEM) as a Cloud Service中,用于内容片段投放的AEM OpenAPI:

  • 是一个OpenAPI,它针对JSON格式的AEM内容片段的实时投放进行了优化
  • 提供允许活动内容失效的现代CDN集成
  • 侧重于内容交付(性能、可扩展性、CDN集成、优化的JSON控制和输出)
  • 包括为引用的片段和资产水合JSON的功能

此API:

有关完整文档,请参阅使用OpenAPI的AEM内容片段交付

NOTE
有关可用的各种API的概述以及所涉及概念的比较,请参阅结构化内容交付和管理的AEM API
IMPORTANT
要在AEM as a Cloud Service上使用OpenAPI启用内容片段投放,请确保尚未启用,然后提交标题为​ 使用OpenAPI启用内容片段投放 ​的Adobe支持票证,并指定:
  • Cloud Service项目和环境ID
  • 您希望通过内容片段投放OpenAPI解决的用例的详细信息
  • Adobe应响应并随时了解请求和项目(如果需要)的所有联系人的详细信息

缓存 caching

AEM与AEM CDN Fastly集成。 这意味着在发布层上提供的JSON响应将缓存在Fastly级别。

然后,根据预定义的缓存标头缓存响应(无法配置):

  • 响应在浏览器/客户端缓存中缓存5分钟
    • max-age=300
  • 响应在CDN缓存中缓存1小时
    • s-maxage=3600
  • 在重新验证新请求时,可为过时内容提供长达1小时的服务
    • stale-while-revalidate=3600
  • 过时内容可错误提供长达1天
    • stale-on-error=86400

使用OpenAPI的内容片段投放支持活动CDN缓存失效。 这意味着每当更新或发布内容时,相应的JSON OpenAPI响应都会通过向Fastly发出的软清除请求自动失效。 这样,您就可以在到达实际CDN缓存期限(s-maxage)之前,看到在JSON输出中反映的更改。

可用性 availability

使用OpenAPI的内容片段投放在预览层和发布层上可用。 OpenAPI以JSON格式提供内容片段,用于预览和实时交付。

要预览使用OpenAPI的内容片段投放,可以:

  • 发布到预览
  • 启用访问以通过IP允许列表预览
  • 获取预览URL

CORS cors

CORS允许的源定义可以调用API的源。

此API不考虑在Dispatcher配置端定义、专门用于GraphQL的CORS允许的源。

API速率限制 api-rate-limits

API允许新请求的速率为每环境每秒最多200个请求。

一旦超过此限制,API将开始发送429错误响应。 这些错误必须由任何客户端应用程序处理,并且失败的请求在指数回退重试后重试。 HTTP响应带有特定的标头Retry-After,该标头会向客户端指示再次发送请求之前需要等待的时间。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab