Autenticar e acessar a API do Reator

Para utilizar a variável API do Reator para criar e gerenciar extensões de tags, cada solicitação deve incluir os seguintes cabeçalhos de autenticação:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Este guia mostra como usar o Adobe Developer Console a fim de coletar os valores de cada um desses cabeçalhos para que você possa começar a fazer chamadas à API do reator.

Obter acesso de desenvolvedor à Adobe Experience Platform gain-developer-access

A fim de gerar valores de autenticação para a API do reator, você deve ter acesso de desenvolvedor à Experience Platform. Para obter acesso de desenvolvedor, siga as etapas iniciais no tutorial de autenticação da Experience Platform. Depois de concluir o Obter acesso do usuário retorne a este tutorial para gerar as credenciais específicas da API do Reator.

Gerar credenciais de acesso generate-access-credentials

Usando o Adobe Developer Console, você deve gerar as três credenciais de acesso descritas a seguir:

  • {ORG_ID}
  • {API_KEY}
  • {ACCESS_TOKEN}

A ID da sua organização ({ORG_ID}) e a chave de API ({API_KEY}) podem ser reutilizadas em chamadas de API futuras depois de terem sido geradas inicialmente. No entanto, seu token de acesso ({ACCESS_TOKEN}) é temporário e deve ser gerado novamente a cada 24 horas.

As etapas de geração desses valores são descritas em detalhes abaixo.

Configuração única one-time-setup

Acesse o Adobe Developer Console e faça logon com seu Adobe ID. Depois, siga as etapas descritas no tutorial sobre como criar um projeto vazio na documentação do Developer Console.

Depois de criar um projeto, selecione Adicionar API na tela Visão geral do projeto.

A tela Adicionar uma API é exibida. Selecionar API EXPERIENCE PLATFORM LAUNCH na lista de APIs disponíveis antes de selecionar Próxima.

Em seguida, selecione o tipo de autenticação para gerar tokens de acesso e acessar a API Experience Platform.

IMPORTANT
Selecione o Servidor OAuth para servidor método, pois esse será o único método compatível a partir de agora. A variável Conta de serviço (JWT) está obsoleto. Embora as integrações que usam o método de autenticação JWT continuem a funcionar até 1º de janeiro de 2025, a Adobe recomenda que você migre as integrações existentes para o novo método servidor para servidor OAuth antes dessa data. Obter mais informações na seção+----------------+ | badge negative | +================+ | Obsoleto | +----------------+Gerar um JSON Web Token (JWT) no tutorial de autenticação da API da plataforma.

Clique em Avançar para continuar.

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

A próxima tela solicita que você selecione um ou mais perfis de produto para associar à integração com a API.

NOTE
Os perfis de produto são gerenciados por sua organização por meio da Adobe Admin Console e contêm conjuntos específicos de permissões para recursos granulares. Os perfis de produto e suas permissões só podem ser gerenciados por usuários com privilégios de administrador na organização. Se não tiver certeza sobre quais perfis de produto deve selecionar para a API, entre em contato com o administrador.

Selecione os perfis de produto desejados na lista e selecione Salvar API configurada para concluir o registro da API.

Coletar credenciais gather-credentials

Depois que a API for adicionada ao projeto, o API EXPERIENCE PLATFORM A página do projeto exibe as seguintes credenciais que são necessárias em todas as chamadas para as APIs Experience Platform:

  • {API_KEY} (ID do cliente)
  • {ORG_ID} (ID da organização)

Informações de integração após adicionar uma API no Console do desenvolvedor.

Gerar um token de acesso generate-access-token

A próxima etapa é gerar um {ACCESS_TOKEN} credencial para uso em chamadas de API da plataforma. Ao contrário dos valores de {API_KEY} e {ORG_ID}, um novo token deve ser gerado a cada 24 horas para continuar usando as APIs da plataforma.

TIP
Esses tokens expiram após 24 horas. Se você está usando essa integração para um aplicativo, convém obter o token de portador de forma programática por meio do aplicativo.

Você tem duas opções para gerar os tokens de acesso, dependendo do caso de uso:

Gerar tokens de acesso manualmente manual

Para gerar manualmente um novo {ACCESS_TOKEN}, navegue até Credenciais > Servidor OAuth para servidor e selecione Gerar token de acesso, conforme mostrado abaixo.

Gravação de tela de como o token de acesso é gerado na interface do usuário do Console do desenvolvedor.

É gerado um novo token de acesso, e é fornecido um botão para copiá-lo para a área de transferência. Esse valor é usado para o cabeçalho de Autorização necessário e deve ser fornecido no formato Bearer {ACCESS_TOKEN}.

Geração de token automatizada auto-token

Você também pode usar um ambiente e uma coleção do Postman para gerar tokens de acesso. Para obter mais informações, leia a seção sobre uso do Postman para autenticar e testar chamadas de API no guia de autenticação da API do Experience Platform.

Credenciais da API de teste test-api-credentials

Seguindo as etapas deste tutorial, você deve ter valores válidos para {ORG_ID}, {API_KEY}, e {ACCESS_TOKEN}. Agora é possível testar esses valores usando-os em uma solicitação de cURL simples para a API do Reactor.

Para começar, tente fazer uma chamada de API para listar todas as empresas.

NOTE
Talvez você não tenha empresas em sua organização. Nesse caso, a resposta será o status HTTP 404 (Não encontrado). Desde que você não receba um erro 403 (Proibido), suas credenciais de acesso são válidas e estão funcionando.

Depois de confirmar que suas credenciais de acesso estão funcionando, continue explorando a outra documentação de referência da API para saber mais sobre os vários recursos da API.

Leitura de chamadas de API de amostra read-sample-api-calls

Cada manual de endpoint fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no guia de introdução às APIs da Platform.

Próximas etapas next-steps

Agora que você entende quais cabeçalhos usar, você está pronto para começar a fazer chamadas para a API do Reator. Selecione um dos manuais de endpoint para começar:

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743