APIs do AEM baseadas na OpenAPI
Saiba mais sobre as APIs do AEM baseadas na OpenAPI, incluindo autenticações compatíveis, conceitos principais e como acessar APIs da Adobe.
A Especificação da OpenAPI (anteriormente conhecida como Swagger) é um padrão amplamente usado para definir APIs RESTful. O AEM as a Cloud Service fornece várias APIs baseadas na especificação OpenAPI (ou simplesmente APIs do AEM baseadas na OpenAPI), facilitando a criação de aplicativos personalizados que interagem com os tipos de serviço de criação ou publicação do AEM. Confira abaixo alguns exemplos:
Sites
- APIs de sites: APIs para trabalhar com fragmentos de conteúdo.
Ativos
-
API de pastas: APIs para trabalhar com pastas, como criar, listar e excluir pastas.
-
API de criação de ativos: APIs para trabalhar com ativos e seus metadados.
Formulários
- APIs de comunicações de formulários: APIs para trabalhar com formulários e documentos.
Em versões futuras, mais APIs do AEM baseadas na OpenAPI serão adicionadas para permitir casos de uso adicionais.
Autenticação compatível authentication-support
As APIs do AEM baseadas na OpenAPI são compatíveis com a autenticação OAuth 2.0, incluindo os seguintes tipos de concessão:
-
Credencial OAuth de servidor para servidor: ideal para serviços de back-end que precisam de acesso à API sem interação com o usuário. Ela usa o tipo de concessão client_credentials, permitindo um gerenciamento de acesso seguro na camada do servidor. Para mais informações, consulte Credencial OAuth de servidor para servidor.
-
Credencial OAuth para aplicativos web: adequada para aplicativos web com componentes de front-end e back-end que acessam as APIs do AEM em nome dos usuários. Ela usa o tipo de concessão authorization_code, com a qual o servidor de back-end gerencia segredos e tokens de forma segura. Para mais informações, consulte Credencial OAuth para aplicativos web.
-
Credencial OAuth para aplicativos de página única: projetada para aplicativos de página única (SPAs) em execução no navegador que precisam acessar APIs em nome de um usuário sem um servidor de back-end. Ela usa o tipo de concessão authorization_code e depende de mecanismos de segurança do lado do cliente que utilizam uma PKCE (chave de prova para troca de código) para proteger o fluxo do código de autorização. Para mais informações, consulte Credencial OAuth para aplicativos de página única.
Qual método de autenticação usar auth-method-decision
Ao decidir qual método de autenticação usar, considere o seguinte:
A autenticação do usuário (no aplicativo web ou aplicativo de página única) deve ser a opção padrão sempre que o contexto do usuário do AEM estiver envolvido. Isso garante que todas as ações no repositório sejam corretamente atribuídas ao usuário autenticado e que o usuário seja restrito somente às permissões às quais tem direito.
O uso do sistema de servidor para servidor (ou conta de sistema técnico) para executar ações em nome de um usuário individual ignora o modelo de segurança e traz riscos, como escalonamento de privilégios e auditorias imprecisas.
Diferença entre credenciais OAuth de servidor para servidor, para aplicativos web e para aplicativos de página única difference-between-oauth-server-to-server-vs-web-app-vs-single-page-app-credentials
A tabela a seguir resume as diferenças entre os três métodos de autenticação OAuth compatíveis com as APIs do AEM baseadas na OpenAPI:
client_id, client_secret) com segurança em sistemas back-end.client_id, client_secret) nos sistemas de back-end para trocar o código de autorização pelo token de acesso.client_secret, pois não é seguro armazenar em aplicativos front-end. Depende da PKCE para trocar o código de autorização por um token de acesso.Acesso às APIs da Adobe e conceitos relacionados accessing-adobe-apis-and-related-concepts
Antes de acessar as APIs da Adobe, é essencial compreender estes conceitos principais:
-
Adobe Developer Console: o hub de desenvolvimento para acessar APIs, SDKs, eventos em tempo real, funções sem servidor da Adobe e muito mais. Observe que ele é diferente do Developer Console do AEM, que é usado para depurar aplicativos do AEM.
-
Projeto do Adobe Developer Console: local central para gerenciar integrações de API, eventos e funções de tempo de execução. Aqui é possível configurar APIs, definir a autenticação e gerar as credenciais necessárias.
-
Perfis de produto: os perfis de produto fornecem uma predefinição de permissão que permite controlar o acesso do usuário ou do aplicativo a produtos da Adobe, como o AEM, Adobe Target, Adobe Analytics, entre outros. Todos os produtos da Adobe têm perfis de produto predefinidos associados.
-
Serviços: definem as permissões reais e estão associados ao perfil de produto. Para reduzir ou aumentar a predefinição de permissões, é possível desmarcar ou selecionar os serviços associados ao perfil do produto. Dessa forma, você pode controlar o nível de acesso ao produto e suas APIs. No AEM as a Cloud Service, os serviços representam grupos de usuários com listas de controle de acesso (ACLs) predefinidas para nós de repositório, permitindo o gerenciamento granular de permissões.
Introdução
Saiba como configurar seu ambiente do AEM as a Cloud Service e um projeto do Adobe Developer Console para habilitar o acesso às APIs do AEM baseadas em OpenAPI. Também é possível acessar a API do AEM usando o navegador para verificar a configuração e revisar a solicitação e a resposta.
Configurar APIs do AEM baseadas em OpenAPI
Saiba como configurar o ambiente do AEM as a Cloud Service para habilitar o acesso às APIs do AEM baseadas em OpenAPI.
Tutoriais sobre APIs
Saiba como usar as APIs do AEM baseadas em OpenAPI, usando diferentes métodos de autenticação por OAuth:
Invocar API com autenticação de servidor para servidor
Saiba como invocar as APIs do AEM baseadas em OpenAPI de um aplicativo NodeJS personalizado por meio da autenticação OAuth de servidor para servidor.
Invocar API com autenticação para aplicativos web
Saiba como invocar as APIs do AEM baseadas em OpenAPI de um aplicativo web personalizado por meio da autenticação OAuth para aplicativos web.
Invocar API com autenticação para aplicativos de página única
Saiba como invocar as APIs do AEM baseadas em OpenAPI de um aplicativo de página única (SPA) personalizado por meio da autenticação OAuth para aplicativos de página única.