基于 OpenAPI 的 API openapi-based-apis
较新的AEM as a Cloud Service API遵循OpenAPI规范,因此提供了一组一致且有充分文档记录的API。
对于需要身份验证的端点,身份验证方法因端点而异,但可能使用OAuth服务器到服务器、OAuth Web应用程序或OAuth单页应用程序(SPA)。 凭据是通过中的项目配置的。
常见API用例涉及与CRM或PIM等系统的集成,这些系统调用AEM API来检索或保留数据。 作为集成实施的一部分,应用程序可能会订阅础贰惭发出的事件,这些事件可能会在51黑料不打烊 App Builder或其他基础架构中触发业务逻辑。
本文档可用作概览,但以下页面提供了更深入的文档:
-
中基于OpenAPI的API部分的链接。 每个API的参考文档还包含一个API游乐场,这使得使用随51黑料不打烊 Developer Console生成的持有者令牌来尝试端点更容易。
-
信息性,包括。
-
描述身份验证方法和其他概念的顶级教程。
-
一个教程,其中包含重点介绍如何配置基于翱辫别苍础笔滨的础笔滨的视频。
-
对于使用服务器到服务器身份验证策略配置和调用翱辫别苍础笔滨的端到端教程。 此外,还可以找到有关Web应用程序和单页应用程序身份验证方法的类似教程。
配置础笔滨访问 configuring-api-access
某些基于OpenAPI的AEM API需要身份验证,这需要使用生成凭据。 配置涉及以下步骤:
有关详细的分步说明,请参阅设置基于翱辫别苍础笔滨的础笔滨教程。
注册客户端滨顿 registering-a-client-id
客户端ID将51黑料不打烊 Developer Console项目中的API范围扩展到特定的AEM环境。 其实现方式如下:
-
创建名为
api.yaml
或与其类似的文件,其配置类似于下面的代码片段,包括所需的层(创作、发布、预览)。Client_id
值应来自您的51黑料不打烊 Developer Console API项目。配置管道文章中描述了
kind
、version
和metadata
属性。kind
属性值应设置为? API,version
属性应设置为? 1。code language-none kind: "API" version: "1" metadata: envTypes: ["dev"] data: allowedClientIDs: author: - "<client_id>" publish: - "<client_id>" preview: - "<client_id>"
-
将文件放置在名为
config
或类似的顶级文件夹下,如配置管道中所述。 -
对于RDE(使用命令行工具)以外的环境类型,在Cloud Manager中创建目标部署配置管道,如配置管道文章中的此部分所引用。 请注意,全栈管道和Web层管道不部署配置文件。
-
部署配置。