Autenticação de servidor para servidor OAuth

A autenticação de servidor para servidor do OAuth permite acesso seguro e baseado em token às APIs de comunicações da AEM Forms sem exigir interação com o usuário. A autenticação de servidor para servidor OAuth é compatível com o Adobe Developer Console.

Pré-requisitos

Antes de começar, verifique se os seguintes pré-requisitos foram atendidos:

Como gerar um token de acesso usando a autenticação de servidor para servidor do OAuth?

Siga as etapas abaixo para gerar um token de acesso do console do Adobe Developer e fazer sua primeira chamada de API por meio da autenticação de servidor para servidor OAuth.

​1. Configuração do projeto do Adobe Developer Console

  1. Navegue até Adobe Developer Console

  2. Faça logon com sua Adobe ID

  3. Criar novo projeto ou navegar até o projeto existente

Para criar um novo projeto
  1. Na seção Início rápido, clique em Criar novo projeto

  2. Um novo projeto é criado com um nome padrão

    Criar projeto ADC

  3. Clique em Editar projeto no canto superior direito

    Editar Projeto

  4. Forneça um nome significativo (por exemplo, "formsproject")

  5. Clique em Salvar

    Editar Nome do Projeto

Para navegar até o projeto existente
  1. Clique em Todos os projetos da Adobe Developer Console

    Pesquisar Projetos

  2. Localize o projeto e clique em para abri-lo.

    Localizar Projetos

​2. Adicionar APIs do Forms

Adicione APIs do Forms com base no que você deseja fazer:

  • APIs de Comunicações do AEM Forms: use quando precisar gerar, converter, reunir ou proteger documentos (PDF e formatos relacionados).
  • APIs Adaptive Forms Runtime - use quando precisar renderizar, enviar ou processar o Adaptive Forms no tempo de execução.
Para APIs de comunicações do AEM Forms
  1. Clique em Adicionar API

    Adicionar API

  2. Selecione as APIs de comunicação do Forms

    1. Na caixa de diálogo Adicionar API, filtre por Experience Cloud

    2. Selecione "APIs de comunicação do Forms"

      Adicionar API de comunicação do Forms

    3. Clique em Avançar

    4. Selecione o método de autenticação Servidor a Servidor do OAuth

      Selecionar método de autenticação

Para APIs Adaptive Forms Runtime
  1. Clique em Adicionar API

    Adicionar API

  2. Selecionar API de Entrega e Tempo de Execução do AEM Forms

    1. Na caixa de diálogo Adicionar API, filtre por Experience Cloud

    2. Selecione "API de Entrega e Tempo de Execução do AEM Forms"
      Adicionar API de comunicação do Forms

    3. Clique em Avançar

    4. Selecione o método de autenticação OAuth de servidor para servidor.
      Selecionar método de autenticação

Você também pode adicionar a API e o método de autenticação ao seu projeto existente clicando em Adicionar ao projeto > API
Adicionar API ao projeto existente

​3. Adicionar perfil de produto

O perfil de produto fornece permissões (ou autorização) para credenciais para acessar os recursos do AEM.

  1. Selecione o Perfil do Produto que corresponda à URL da instância do AEM (https://Service Type -Environment Type-Program XXX-Environment XXX.adobeaemcloud.com).

    • Tipo de Serviço - especifica os serviços ou permissões associados à instância do AEM

    • Tipo de ambiente - especifica se o ambiente é para o serviço de Autor ou Publicação

    • Programa XXX - identifica a ID do programa Cloud Manager

    • Ambiente XXX - identifica a ID de ambiente específica dentro desse programa

    note note
    NOTE
    Os perfis de produto estão vinculados a uma instância específica do AEM (programa + ambiente). Sempre escolha o perfil que corresponde ao URL da instância.
  2. Clique em Salvar API configurada. A API e o Perfil de produto são adicionados ao seu projeto

    Selecionar configuração do projeto

​4. Gerar e salvar credenciais

  1. Navegar até o projeto no Adobe Developer Console

  2. Clique na credencial OAuth de servidor para servidor

  3. Exibir a seção Detalhes da credencial

    Exibir Credenciais

Credenciais da API de registro

    API Credentials:
    ================
    Client ID: <your_client_id>
    Client Secret: <your_client_secret>
    Technical Account ID: <tech_account_id>
    Organization ID: <org_id>
    Scopes: AdobeID,openid,read_organizations

​5. Geração de token de acesso

Gere o token de acesso manual ou programaticamente:

Para Teste

Gerar tokens de acesso manualmente no Adobe Developer Console:

  1. Navegar até o seu projeto

    1. No Adobe Developer Console, abra o projeto
    2. Clique em Servidor a servidor OAuth
  2. Gerar token de acesso

    1. Clique no botão "Gerar token de acesso" na seção API do projeto
    2. Copiar o token de acesso gerado

    Gerar token de acesso

    note note
    NOTE
    O token de acesso é válido somente por 24 horas
Para Produção

Gerar tokens de forma programática usando a API do Adobe IMS:

Credenciais necessárias:

  • ID do cliente
  • Segredo do cliente
  • Escopos (normalmente: openid, AdobeID, read_organizations, additional_info.projectedProductContext, read_pc.dma_aem_cloud, aem.document)

Ponto de Extremidade do Token:

code language-none
https://ims-na1.adobelogin.com/ims/token/v3

Solicitação de Exemplo (curl):

code language-bash
curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials' \
-d 'client_id=<YOUR_CLIENT_ID>' \
-d 'client_secret=<YOUR_CLIENT_SECRET>' \
-d 'scope=AdobeID,openid,read_organizations'

Resposta:

code language-json
    {
    "access_token": "eyJhbGciOiJSUz...",
    "token_type": "bearer",
    "expires_in": 86399
    }

Agora você pode usar o token de acesso gerado para fazer uma chamada de API para ambientes de desenvolvimento, preparo ou produção.

Práticas recomendadas: gerenciamento de credenciais para desenvolvimento, armazenamento temporário e produção

  • Sempre use credenciais separadas para desenvolvimento, armazenamento temporário e produção.

  • Mapeie cada credencial para o URL de ambiente correto do AEM.

  • Armazene segredos com segurança e nunca os confirme no controle de origem.

  • Rastrear a validade do token de acesso, pois os tokens são válidos somente por 24 horas.

Próximas etapas

Para saber como configurar o ambiente para APIs de comunicação síncrona do Forms, consulte Processamento síncrono das comunicações do AEM Forms as a Cloud Service.

Artigos relacionados

Saiba como definir o ambiente para APIs de comunicações síncronas (sob demanda) e assíncronas (em lote) do Forms:

APIs síncronas

APIs de Comunicações do AEM Forms - Síncronas

Saiba como configurar um ambiente para APIs síncronas (sob demanda) de comunicações do Forms que geram ou processam documentos instantaneamente.

Saiba mais

APIs assíncronas

APIs de Comunicações do AEM Forms - Assíncrono (Lote)

Saiba como configurar um ambiente para APIs assíncronas (em lote) de comunicações do Forms que geram ou processam vários documentos de maneira programada.

Saiba mais

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