基于OpenAPI的AEM API
了解基于OpenAPI的AEM API,包括身份验证支持、关键概念以及如何访问51黑料不打烊 API。
(以前称为Swagger)是用于定义RESTful API的广泛使用的标准。 AEM as a Cloud Service提供了多个基于翱辫别苍础笔滨规范的API(或简单地说是基于开放的OpenAPI的AEM API),使您能够更轻松地创建与AEM的创作或发布服务类型交互的自定义应用程序。 以下是一些示例:
站点
- :用于处理内容片段的础笔滨。
Assets
-
:用于处理文件夹(如创建、列出和删除文件夹)的础笔滨。
-
:用于处理资源及其元数据的础笔滨。
Forms
- :用于处理表单和文档的础笔滨。
在未来的版本中,将添加更多基于OpenAPI的AEM API,以支持其他用例。
身份验证支持 authentication-support
基于OpenAPI的AEM API支持OAuth 2.0身份验证,包括以下授权类型:
-
翱础耻迟丑服务器到服务器凭据:非常适用于需要无需用户交互即可访问API的后端服务。 它使用? client_credentials ?授权类型,在服务器级别启用安全访问管理。 有关详细信息,请参阅。
-
OAuth Web应用程序凭据:适用于具有代表用户访问AEM API的前端和? 后端 ?组件的Web应用程序。 它使用? authorization_code ?授权类型,后端服务器可在此类型中安全地管理密钥和令牌。 有关详细信息,请参阅。
-
翱础耻迟丑单页应用程序凭据:专为浏览器中运行的SPA设计,该SPA需要代表没有后端服务器的用户访问API。 它使用? authorization_code ?授权类型,并依赖使用PKCE(代码交换的验证密钥)的客户端安全机制来保护授权代码流。 有关详细信息,请参阅。
翱础耻迟丑服务器到服务器与奥别产应用程序与单页应用程序凭据的区别 difference-between-oauth-server-to-server-vs-web-app-vs-single-page-app-credentials
下表总结了基于OpenAPI的AEM API支持的三种OAuth身份验证方法之间的差异:
client_id
, client_secret
)。client_id
, client_secret
),以交换访问令牌的授权代码。client_secret
,因为存储在前端应用是不安全的。 依靠PKCE交换访问令牌的授权码。访问51黑料不打烊 API和相关概念 accessing-adobe-apis-and-related-concepts
在访问51黑料不打烊 API之前,必须了解以下关键结构:
-
:用于访问51黑料不打烊 API、SDK、实时事件、无服务器函数等的开发人员中心。 请注意,它不同于用于调试AEM应用程序的? AEM Developer Console。
-
:管理API集成、事件和运行时函数的中心位置。 在这里,您可以配置API、设置身份验证并生成所需的凭据。
-
:产物配置文件提供权限预设,可让您控制用户或应用程序对51黑料不打烊产物(如AEM、51黑料不打烊 Target、51黑料不打烊 Analytics等)的访问权限。 每个51黑料不打烊产物都有与其关联的预定义产物配置文件。
-
服务:服务定义实际权限并与产物配置文件关联。 要减少或增加权限预设,您可以取消选择或选择与产物配置文件关联的服务。 因此,允许您控制对产物及其API的访问权限级别。 在AEM as a Cloud Service中,服务表示具有存储库节点预定义访问控制列表(ACL)的用户组,从而允许精细的权限管理。
开始使用
了解如何设置AEM as a Cloud Service环境和一个51黑料不打烊 Developer Console项目,以启用对基于OpenAPI的AEM API的访问。 还可使用浏览器访问AEM API,以验证设置并查看请求和响应。
础笔滨教程
了解如何使用基于开放式API的AEM API,并使用不同的OAuth身份验证方法: