DocumentaçãoAEM as a Cloud ServiceGuia do usuário

APIs baseadas em OpenAPI openapi-based-apis

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Aplica-se a:
  • Experience Manager as a Cloud Service

Criado para:

  • Administrador
  • Desenvolvedor

As APIs mais recentes do AEM as a Cloud Service seguem a especificação da OpenAPI e, portanto, oferecem um conjunto consistente e bem documentado de APIs.

NOTE
Um tutorial completo é um recurso recomendado para aprender a configurar e chamar as APIs do AEM baseadas em OpenAPI.

Para endpoints que exigem autenticação, a abordagem de autenticação é diferente com base no endpoint, mas pode usar OAuth de servidor para servidor, OAuth Web App ou OAuth Single Page App (SPA). As credenciais são configuradas por meio de projetos em Adobe Developer Console.

Casos de uso comuns de API envolvem integrações com sistemas, como um CRM ou PIM, em que as APIs do AEM são chamadas para recuperar ou persistir dados. Como parte da implementação da integração, os aplicativos podem assinar eventos emitidos pela AEM, o que pode acionar a lógica de negócios no Adobe App Builder ou em outra infraestrutura.

Este documento serve como uma visão geral, mas uma documentação mais detalhada está disponível nas seguintes páginas:

  • Os links da seção API baseada em OpenAPI da documentação de referência. Cada documentação de referência da API também inclui um playground de API, o que facilita a tentativa de um endpoint usando um token de portador gerado com o Adobe Developer Console.

  • Guias informativos, incluindo conceitos e sintaxe de API.

  • Um tutorial de nível superior descrevendo abordagens de autenticação e outros conceitos.

  • Um tutorial em vídeo focado em como configurar as APIs baseadas em OpenAPI.

  • Tutorial completo sobre a configuração e a chamada de OpenAPIs com a estratégia de autenticação de servidor para servidor. Tutoriais semelhantes também podem ser encontrados para as abordagens de autenticação de Aplicativo de página única e Aplicativo da Web.

Configuração do acesso à API configuring-api-access

Algumas APIs do AEM baseadas em OpenAPI precisam de autenticação, o que requer que as credenciais sejam geradas usando o Adobe Developer Console. A configuração envolve as seguintes etapas:

  1. Modernização do ambiente do AEM as a Cloud Service.
  2. Habilite o acesso às APIs do AEM usando Perfis de Produto.
  3. Crie um projeto do Adobe Developer Console (ADC).
  4. Configure o projeto ADC. Isso gera credenciais que serão usadas posteriormente para trocar por um token de portador ao invocar a API.
  5. Configure a instância do AEM para habilitar a comunicação do Projeto ADC. Isso envolve o registro da ID do cliente com o ambiente configurando e implantando um arquivo YAML, conforme descrito na seção Registrando uma ID do cliente abaixo.

Para obter instruções detalhadas, consulte o Tutorial Configurar APIs baseadas em OpenAPI.

Registrar uma ID do cliente registering-a-client-id

As IDs de clientes definem o escopo das APIs em um projeto do Adobe Developer Console para ambientes AEM específicos. Isso é feito da seguinte maneira:

  1. Crie um arquivo chamado api.yaml ou similar com uma configuração como a do trecho abaixo, incluindo os níveis desejados (autor, publicação, visualização). Client_id valores devem vir do(s) projeto(s) de API do Adobe Developer Console.

    As propriedades kind, version e metadata estão descritas no artigo Pipeline de Configuração. O valor da propriedade kind deve ser definido como API e a propriedade version deve ser definida como 1.

    code language-none 
    kind: "API"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  allowedClientIDs:
    author:
      - "<client_id>"
    publish:
      - "<client_id>"
    preview:
      - "<client_id>"

  2. Coloque o arquivo em algum lugar em uma pasta de nível superior chamada config ou similar, conforme descrito em Pipeline de configuração.

  3. Para tipos de ambiente diferentes de RDE (que usa ferramentas de linha de comando), crie um pipeline de configuração de implantação direcionada no Cloud Manager, conforme referenciado por esta seção no artigo Pipeline de configuração. Observe que os pipelines de Empilhamento completo e de Camada da Web não implantam o arquivo de configuração.

  4. Implante a configuração.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab