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

Configurar APIs do AEM baseadas em OpenAPI

Last update: Thu May 15 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 como configurar o ambiente do AEM as a Cloud Service para habilitar o acesso às APIs do AEM baseadas em OpenAPI.

Neste exemplo, a API do AEM Assets usando o método de autenticação de servidor para servidor é usada para demonstrar o processo de configuração. As mesmas etapas podem ser seguidas para outras APIs do AEM baseadas em OpenAPI.

video poster

https://video.tv.adobe.com/v/3457510?quality=12&learn=on

O processo de configuração de alto nível envolve as seguintes etapas:

Modernização do ambiente do AEM as a Cloud Service.
Ative o acesso às APIs do AEM.
Criar projeto do Adobe Developer Console (ADC).
Configurar projeto ADC.
Configure a instância do AEM para habilitar a comunicação do Projeto ADC.

Modernização do ambiente do AEM as a Cloud Service modernization-of-aem-as-a-cloud-service-environment

A modernização do ambiente do AEM as a Cloud Service é uma atividade única por ambiente que envolve as seguintes etapas:

Atualize para o AEM versão 2024.10.18459.20241031T210302Z ou posterior.
Adicione novos Perfis de produto a ele se o ambiente tiver sido criado antes da versão 2024.10.18459.20241031T210302Z.

Atualizar instância do AEM update-aem-instance

Para atualizar a instância do AEM, na seção Ambientes do Adobe Cloud Manager, selecione o ícone reticências ao lado do nome do ambiente e selecione a opção Atualizar.

Atualizar instância do AEM

Em seguida, clique no botão Enviar e execute o Pipeline de Pilha Completa sugerido.

Selecionar a versão mais recente do AEM

No meu caso, o Pipeline de Pilha Completa é nomeado como Dev :: Fullstack-Deploy, e o ambiente do AEM é chamado wknd-program-dev. Seus nomes podem ser diferentes.

Adicionar novos perfis de produto add-new-product-profiles

Para adicionar novos Perfis de produto à instância do AEM, na seção Ambientes do Adobe Cloud Manager, selecione o ícone reticências ao lado do nome do ambiente e selecione a opção Adicionar Perfis de Produto.

Adicionar novos Perfis de Produtos

Você pode revisar os Perfis de Produtos recém-adicionados clicando no ícone reticências ao lado do nome do ambiente e selecionando Gerenciar Acesso > Perfis de Autores.

A janela Admin Console exibe os Perfis de Produto adicionados recentemente.

Revisar novos Perfis de Produtos

As etapas acima concluem a modernização do ambiente do AEM as a Cloud Service.

Habilitar o acesso às APIs do AEM enable-aem-apis-access

A presença dos novos Perfis de produto habilita o acesso à API do AEM com base em OpenAPI no Adobe Developer Console (ADC). Lembre-se de que o Adobe Developer Console (ADC) é o hub do desenvolvedor para acessar APIs, SDKs, eventos em tempo real, funções sem servidor da Adobe e muito mais.

Os Perfis de Produto adicionados recentemente estão associados aos Serviços que representam os grupos de usuários da AEM com ACLs (Listas de Controle de Acesso) predefinidas. Os Serviços são usados para controlar o nível de acesso às APIs do AEM.

Você também pode marcar ou desmarcar os Serviços associados ao Perfil de Produto para reduzir ou aumentar o nível de acesso.

Revise a associação clicando no ícone Exibir Detalhes ao lado do nome do Perfil do Produto.

Serviços de revisão associados ao Perfil de Produto

Habilitar o acesso às APIs do AEM Assets enable-aem-assets-apis-access

Por padrão, o Serviço de Usuários da API do AEM Assets não está associado a nenhum Perfil de Produto. Vamos associá-lo aos Usuários do AEM Assets Collaborator recentemente adicionados - autor - Programa XXX - Ambiente XXX Perfil do produto ou qualquer outro Perfil de produto que você deseja usar para acesso à API do AEM Assets.

Associar o Serviço de Usuários da API do AEM Assets ao Perfil de Produto

Habilitar autenticação de servidor para servidor

Para habilitar a autenticação de servidor para servidor para as APIs do AEM desejadas, o usuário que configura a integração usando o Adobe Developer Console (ADC) deve ser adicionado como Desenvolvedor ao Perfil do produto onde o Serviço está associado.

Por exemplo, para habilitar a autenticação de servidor para servidor para a API do AEM Assets, o usuário deve ser adicionado como um desenvolvedor ao Perfil de produto Usuários do AEM Assets Collaborator - autor - Programa XXX - Ambiente XXX.

Associar Desenvolvedor ao Perfil de Produto

Após essa associação, a API do Autor de Ativos do ADC Project pode configurar a autenticação de Servidor para Servidor desejada e associar a conta de autenticação do projeto ADC (criada na próxima etapa) ao Perfil do Produto.

IMPORTANT

A etapa acima é crítica para habilitar a autenticação de servidor para servidor para a API do AEM desejada. Sem essa associação, a API do AEM não pode ser usada com o método de autenticação de servidor para servidor.

Criar projeto do Adobe Developer Console (ADC) adc-project

O projeto ADC é usado para adicionar as APIs desejadas, configurar sua autenticação e associar a conta de autenticação ao Perfil do produto.

Para criar um projeto ADC:

Faça logon no Adobe Developer Console usando sua Adobe ID.
Na seção Início Rápido, clique no botão Criar novo projeto.
Ele cria um novo projeto com o nome padrão.
Edite o nome do projeto clicando no botão Editar projeto no canto superior direito. Forneça um nome significativo e clique em Salvar.

Configurar projeto ADC configure-adc-project

Depois de criar o projeto ADC, é necessário adicionar as APIs do AEM desejadas, configurar sua autenticação e associar a conta de autenticação ao Perfil do produto.

Para adicionar APIs do AEM, clique no botão Adicionar API.
Na caixa de diálogo Adicionar API, filtre por Experience Cloud e selecione a API do AEM desejada. Por exemplo, neste caso, a API do autor do ativo está selecionada.

Em seguida, na caixa de diálogo Configurar API, selecione a opção de autenticação desejada. Por exemplo, neste caso, a opção de autenticação Servidor para Servidor está selecionada.

Selecionar autenticação

A autenticação de servidor para servidor é ideal para serviços de back-end que precisam de acesso à API sem interação com o usuário. As opções de autenticação Aplicativo Web e Aplicativo de página única são adequadas para aplicativos que precisam de acesso à API em nome dos usuários. Consulte Diferença entre credenciais de Servidor para Servidor do OAuth vs. Aplicativo Web vs. Aplicativo de Página Única para obter mais informações.

note tip
TIP
Se você não vir a opção de autenticação de servidor para servidor, significa que o usuário que está configurando a integração não é adicionado como Desenvolvedor ao Perfil do produto ao qual o Serviço está associado. Consulte Habilitar autenticação de Servidor para Servidor para obter mais informações.

Se necessário, é possível renomear a API para facilitar a identificação. Para fins de demonstração, o nome padrão é usado.
Nesse caso, o método de autenticação é Servidor a Servidor OAuth, portanto, você precisa associar a conta de autenticação ao Perfil do Produto. Selecione o Perfil de Produto Usuários do AEM Assets Collaborator - autor - Programa XXX - Ambiente XXX e clique em Salvar.
Revise a API do AEM e a configuração de autenticação.

Se você escolher o método de autenticação do Aplicativo Web OAuth ou do Aplicativo de Página Única do OAuth, a associação do Perfil de Produto não será solicitada, mas o URI de redirecionamento do aplicativo será necessário. O URI de redirecionamento do aplicativo é usado para redirecionar o usuário para o aplicativo após a autenticação com um código de autorização. Os tutoriais de casos de uso relevantes descrevem essas configurações específicas de autenticação.

Configure a instância do AEM para habilitar a comunicação do Projeto ADC configure-aem-instance

Para habilitar a ClientID do projeto ADC para comunicação com a instância do AEM, é necessário configurar a instância do AEM.

Isso é feito definindo a configuração da API em um arquivo YAML e implantando-o usando o Pipeline de configuração no Cloud Manager. O arquivo YAML define os ClientIDs permitidos do projeto ADC que podem se comunicar com a instância do AEM.

No AEM Project, localize ou crie o arquivo api.yaml da pasta config.

{width="500"}

Adicione a configuração a seguir ao arquivo api.yaml.

code language-yaml
`kind: "API" version: "1.0" metadata: envTypes: ["dev", "stage", "prod"] data: allowedClientIDs: author: - "<ADC Project's Credentials ClientID>"`

Substitua <ADC Project's Credentials ClientID> pela ClientID real do valor de Credenciais do Projeto ADC. O ponto de extremidade de API usado neste tutorial está disponível somente na camada do autor, mas para outras APIs, a configuração yaml também pode ter um nó publicar ou visualizar.

note caution
CAUTION
Para fins de demonstração, a mesma ClientID é usada para todos os ambientes. É recomendável usar uma ID do cliente separada por ambiente (desenvolvimento, preparo, produção) para melhorar a segurança e o controle.

Confirme as alterações de configuração e envie as alterações para o repositório Git remoto ao qual o pipeline do Cloud Manager está conectado.
Implante as alterações acima usando o Pipeline de configuração no Cloud Manager. Observe que o arquivo api.yaml também pode ser instalado em um RDE, usando ferramentas de linha de comando.

Próximas etapas

Depois que a instância do AEM for configurada para habilitar a comunicação do Projeto ADC, você poderá começar a usar as APIs do AEM baseadas em OpenAPI. Saiba como usar as APIs do AEM baseadas em OpenAPI usando diferentes métodos de autenticação OAuth: