AEM API概述 aem-apis-overview

了解Adobe Experience Manager (AEM)中不同类型的API,并了解为您的集成选择哪个API。

要在AEM中创建、读取、更新和删除内容、资源和表单,开发人员可以使用各种API。 开发人员可通过这些API创建与AEM交互的自定义应用程序。

让我们来探索AEM中的各种API类型,并了解为您的集成选择哪种API。

AEM API的类型 types-of-aem-apis

AEM提供以下API以便与其创作和发布服务类型进行交互。

AEM API类型
描述
可用性
用例
API示例
基于OpenAPI的AEM API
适用于Assets、Sites和Forms的机器可读的标准化API。
仅限AEM as a Cloud Service
API优先开发,现代应用程序
Assets创作API文件夹APIAEM Sites APIForms文档服务API
RESTful API
用于与AEM资源交互的传统REST端点。
AEM 6.X、AEM as a Cloud Service
CRUD操作,现代应用程序
Assets HTTP API工作流REST API内容服务的JSON导出程序
GRAPHQL API
针对通过灵活查询高效地检索结构化内容进行了优化。
AEM 6.X、AEM as a Cloud Service
Headless CMS、SPA、移动应用程序
GraphQL API
传统(非RESTful) API
旧版API,如JCR、Sling模型、查询生成器等。
AEM 6.X、AEM as a Cloud Service
旧版集成,向后兼容性
查询生成器API及其他

有关更多详细信息,请参阅Adobe Experience Manager as a Cloud Service API页面。

要选择的API which-api-to-choose

在为集成选择API时,请考虑以下因素:

  • 用例:确定AEM API是否支持您的用例。 尽可能地,使用基于OpenAPI的AEM API,因为它们提供了与AEM交互的标准化现代方法。 如果基于OpenAPI的API不可用,请考虑使用RESTful API或GraphQL API,作为最后手段,使用传统API。

  • 兼容性:确保选定的API与您的AEM版本兼容。 例如,基于​OpenAPI的AEM API专属于AEM as a Cloud Service,在AEM 6.X中不可用。

  • AEM服务类型:创作与发布:API的选择还取决于它是在Author还是Publish服务上运行,因为它们的访问模型不同。 AEM Author服务用于创建内容,并且始终需要身份验证。 AEM Publish服务用于内容交付,并且可能不需要身份验证,具体取决于用例。

  • 身份验证:验证API是否支持您计划使用的身份验证方法。 例如:

    • 基于OpenAPI的AEM API:支持OAuth 2.0身份验证,包括客户端凭据(服务器到服务器)、授权代码(Web应用程序)和代码交换(单页应用程序)授权类型的验证密钥。 其他AEM API不支持OAuth 2.0身份验证。
    • RESTful API:支持JSON Web令牌(JWT)身份验证,也称为基于令牌的身份验证。

JSON Web令牌(JWT)和OAuth 2.0之间的区别 difference-between-jwt-and-oauth

让我们比较JSON Web令牌(JWT)和OAuth 2.0,AEM API中使用的两种常见身份验证机制:

功能
JSON Web令牌(JWT)
OAuth 2.0
使用位置
RESTful API
基于OpenAPI的AEM API(在RESTful或其他API中不支持)
用途
服务身份验证
用户或服务身份验证
用户交互
无需用户交互
授权代码和单页应用程序授予类型所需的用户交互
最适合
服务器到服务器API调用
应用程序和用户的安全、允许的访问
所需信息
用于签署JWT的私钥
OAuth 2.0的客户端ID和客户端密钥
令牌过期
短期,通常需要更新
访问令牌的生命周期短。 刷新令牌的生命周期长,用于获取新的访问令牌
凭据管理
AEM Developer Console
Adobe Developer Console

基于OpenAPI的AEM API

基于OpenAPI的AEM API指南中了解有关基于OpenAPI的Adobe API以及访问AEM API的重要概念的更多信息。

用例

使用服务器到服务器身份验证调用API

使用服务器到服务器身份验证调用API

了解如何使用OAuth服务器到服务器身份验证从自定义NodeJS应用程序调用基于OpenAPI的AEM API。

了解详情

使用Web应用程序身份验证调用API

使用Web应用程序身份验证调用API

了解如何使用OAuth Web应用程序身份验证,从自定义Web应用程序调用基于OpenAPI的AEM API。

了解详情

使用OAuth单页应用程序调用API

使用OAuth单页应用程序调用API

了解如何使用OAuth 2.0 PKCE流程从自定义单页应用程序(SPA)调用基于OpenAPI的AEM API。

了解详情

GraphQL API — 示例

AEM Headless快速入门 — GraphQL中了解有关GraphQL API以及如何使用它们的更多信息

用例

单页应用程序(SPA)

单页应用程序(SPA)

了解如何使用GraphQL API构建可从AEM中提取内容的单页应用程序(SPA)。

了解详情

移动应用程序

移动应用

了解如何使用GraphQL API构建可从AEM获取内容的移动应用程序。

了解详情

Web组件

Web组件

了解如何使用GraphQL API构建可从AEM中提取内容的Web组件。

了解详情

RESTful API — 示例

详细了解RESTful API,如Assets HTTP APIJSON导出程序

用例

对Headless应用程序使用Content Services

对Headless应用程序使用Content Services

了解如何使用Content Services RESTful API构建可从AEM中提取内容的本机移动应用程序。

了解详情

针对RESTful API的基于令牌的身份验证

针对RESTful API的基于令牌的身份验证

了解如何使用JSON Web令牌(JWT)身份验证调用RESTful API。

了解详情

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69