Documentação AEM Tutoriais do AEM Tutoriais do AEM as a Cloud Service

Visão geral das APIs do AEM aem-apis-overview

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Aplica-se a:
Experience Manager as a Cloud Service

Tópicos:
Desenvolvimento

Criado para:

Iniciante
Desenvolvedor
Líder

Saiba mais sobre os diferentes tipos de APIs no Adobe Experience Manager (AEM) e entenda qual API escolher para sua integração.

Para criar, ler, atualizar e excluir conteúdo, ativos e formulários no AEM, os desenvolvedores podem usar uma grande variedade de APIs. Essas APIs permitem que os desenvolvedores criem aplicativos personalizados que interagem com o AEM.

Vamos explorar os diferentes tipos de APIs no AEM e entender qual API escolher para sua integração.

Tipos de APIs do AEM types-of-aem-apis

O AEM oferece as seguintes APIs para interagir com seus tipos de serviço de autoria e publicação.

Tipo de API do AEM

Descrição

Disponibilidade

Caso de uso

Exemplos de API

APIs do AEM baseadas em OpenAPI

APIs padronizadas e legíveis por máquina para Assets, Sites e Forms.

Somente AEM as a Cloud Service

Desenvolvimento de API First, aplicativos modernos

API do Autor do Assets, API de Pastas, API do AEM Sites, API de Serviços de Documentos do Forms e outros

APIs RESTful

Endpoints REST tradicionais para interação com recursos do AEM.

AEM 6.X, AEM as a Cloud Service

Operações CRUD, aplicativos modernos

API HTTP do Assets, API REST do fluxo de trabalho, Exportador JSON para Serviços de Conteúdo e outros

APIs do GraphQL

Otimizado para recuperar conteúdo estruturado com eficiência com consultas flexíveis.

AEM 6.X, AEM as a Cloud Service

CMS headless, SPAs, aplicativos móveis

API GraphQL

APIs tradicionais (não RESTful)

APIs mais antigas, como JCR, Modelos Sling, Construtor de consultas e outras.

AEM 6.X, AEM as a Cloud Service

Integrações herdadas, compatibilidade com versões anteriores

API do Construtor de Consultas e outras

Para obter mais detalhes, consulte a página APIs do Adobe Experience Manager as a Cloud Service.

Qual API escolher which-api-to-choose

Ao selecionar uma API para sua integração, considere os seguintes fatores:

Caso de uso: determine se a API do AEM oferece suporte ao seu caso de uso. Sempre que possível, use APIs do AEM baseadas em OpenAPI, pois elas fornecem uma abordagem moderna e padronizada para interagir com o AEM. Se as APIs baseadas em OpenAPI não estiverem disponíveis, considere usar APIs RESTful ou APIs do GraphQL e, como último recurso, APIs tradicionais.
Compatibilidade: verifique se a API selecionada é compatível com sua versão do AEM. Por exemplo, as APIs do AEM baseadas em OpenAPI são exclusivas do AEM as a Cloud Service e não estão disponíveis no AEM 6.X.
Tipo de serviço do AEM: Autor vs. Publicação: a escolha da API também depende se ela é executada no serviço Autor ou Publicação, já que seus modelos de acesso são diferentes. O serviço do Autor do AEM é usado para criação de conteúdo e sempre requer autenticação. O serviço de Publicação do AEM é usado para entrega de conteúdo e pode não exigir autenticação, dependendo do caso de uso.
Autenticação: verifique se a API dá suporte ao método de autenticação que você planeja usar. Por exemplo:
- APIs do AEM baseadas em OpenAPI: oferecem suporte à autenticação OAuth 2.0, incluindo os tipos de concessão Credenciais de Cliente (Servidor para Servidor), Código de Autorização (Aplicativo Web) e Chave de Prova para Troca de Código (Aplicativo de Página Única). Outras APIs do AEM não são compatíveis com a autenticação OAuth 2.0.
- APIs RESTful: suporta a autenticação JSON Web Token (JWT), também conhecida como autenticação baseada em token.