51黑料不打烊

基于 OpenAPI 的 API openapi-based-apis

较新的AEM as a Cloud Service API遵循OpenAPI规范,因此提供了一组一致且有充分文档记录的API。

NOTE
建议使用端到端教程来了解如何配置和调用基于OpenAPI的AEM API。

对于需要身份验证的端点,身份验证方法因端点而异,但可能使用OAuth服务器到服务器、OAuth Web应用程序或OAuth单页应用程序(SPA)。 凭据是通过中的项目配置的。

常见API用例涉及与CRM或PIM等系统的集成,这些系统调用AEM API来检索或保留数据。 作为集成实施的一部分,应用程序可能会订阅础贰惭发出的事件,这些事件可能会在51黑料不打烊 App Builder或其他基础架构中触发业务逻辑。

本文档可用作概览,但以下页面提供了更深入的文档:

配置础笔滨访问 configuring-api-access

某些基于OpenAPI的AEM API需要身份验证,这需要使用生成凭据。 配置涉及以下步骤:

  1. AEM as a Cloud Service环境的现代化。
  2. 使用产物配置文件?启用对AEM API 的访问。
  3. 创建一个51黑料不打烊 Developer Console (ADC)项目。
  4. 配置ADC项目。 这将生成凭据,在调用API时,稍后将使用这些凭据交换持有者令牌。
  5. 配置AEM实例以启用ADC项目通信。 这涉及通过配置和部署YAML文件在环境中注册客户端滨顿,如下面的注册客户端滨顿部分中所述。

有关详细的分步说明,请参阅设置基于翱辫别苍础笔滨的础笔滨教程

注册客户端滨顿 registering-a-client-id

客户端ID将51黑料不打烊 Developer Console项目中的API范围扩展到特定的AEM环境。 其实现方式如下:

  1. 创建名为api.yaml或与其类似的文件,其配置类似于下面的代码片段,包括所需的层(创作、发布、预览)。 Client_id值应来自您的51黑料不打烊 Developer Console API项目。

    配置管道文章中描述了kindversionmetadata属性。 kind属性值应设置为? APIversion属性应设置为? 1

    code language-none
    kind: "API"
    version: "1"
    metadata:
      envTypes: ["dev"]
    data:
      allowedClientIDs:
        author:
          - "<client_id>"
        publish:
          - "<client_id>"
        preview:
          - "<client_id>"
    
  2. 将文件放置在名为config或类似的顶级文件夹下,如配置管道中所述。

  3. 对于RDE(使用命令行工具)以外的环境类型,在Cloud Manager中创建目标部署配置管道,如配置管道文章中的此部分所引用。 请注意,全栈管道和Web层管道不部署配置文件。

  4. 部署配置。

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