Authenticate and access Experience Platform APIs

This document provides a step-by-step tutorial for gaining access to an Adobe Experience Platform developer account in order to make calls to Experience Platform APIs.

Autenticar para fazer chamadas de API

Para manter a segurança de seus aplicativos e usuários, todas as solicitações para APIs da Adobe I/O devem ser autenticadas e autorizadas usando padrões como OAuth e JSON Web Tokens (JWT). O JWT é então usado junto com informações específicas do cliente para gerar seu token de acesso pessoal.

Este tutorial aborda as etapas de autenticação através da criação de um token de acesso descrito no seguinte fluxograma:

Pré-requisitos

Para realizar chamadas com êxito para Experience Platform APIs, é necessário o seguinte:

  • Uma organização IMS com acesso ao Adobe Experience Platform
  • Uma conta Adobe ID registrada
  • Um administrador de Admin Console para adicioná-lo como um desenvolvedor e um usuário para um produto.

As seções a seguir abordam as etapas para criar um Adobe ID e se tornar um desenvolvedor e usuário de uma organização.

Criar um Adobe ID

Se você não tiver um Adobe ID, poderá criar um usando as seguintes etapas:

  1. Ir para o Console do desenvolvedor do Adobe
  2. Clique em criar uma nova conta
  3. Concluir o processo de inscrição

Torne-se um desenvolvedor e usuário para Experience Platform uma organização

Antes de criar integrações no Adobe I/O, sua conta deve ter permissões de desenvolvedor para um produto em uma organização IMS. Informações detalhadas sobre contas de desenvolvedor no Admin Console podem ser encontradas no documento de suporte para o gerenciamento de desenvolvedores.

Obter acesso do desenvolvedor

Entre em contato com um Admin Console administrador em sua organização para adicioná-lo como desenvolvedor para um dos produtos da organização usando o Admin Console.

O administrador deve atribuí-lo como desenvolvedor a pelo menos um perfil de produto para continuar.

Depois que você for atribuído como desenvolvedor, terá privilégios de acesso para criar integrações no Adobe I/O. Essas integrações são um pipeline de aplicativos e serviços externos para a API do Adobe.

Obter acesso do usuário

O Admin Console administrador também deve adicioná-lo ao produto como usuário.

Semelhante ao processo de adição de um desenvolvedor, o administrador deve atribuí-lo a pelo menos um perfil de produto para continuar.

Gerar credenciais de acesso no Adobe Developer Console

NOTE

Se você estiver seguindo esse documento no guia do desenvolvedor doPrivacy Service, agora é possível voltar para esse guia para gerar as credenciais de acesso exclusivas para Privacy Service.

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

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

Sua {IMS_ORG} e {API_KEY} só precisam ser geradas uma vez e podem ser reutilizadas em futuras chamadas Platform de API. No entanto, o seu {ACCESS_TOKEN} é temporário e precisa ser regenerado a cada 24 horas.

As etapas são abordadas em detalhes abaixo.

Configuração única

Vá para o Adobe Developer Console e faça logon com seu Adobe ID. Em seguida, siga as etapas descritas no tutorial sobre como criar um projeto vazio na documentação do Console do desenvolvedor do Adobe.

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

A tela Adicionar uma API é exibida. Clique no ícone do produto para Adobe Experience Platform e selecione API ​Experience Platform antes de clicar em Avançar.

Depois de selecionar Experience Platform como a API a ser adicionada ao projeto, siga as etapas descritas no tutorial sobre como adicionar uma API a um projeto usando uma conta de serviço (JWT) (a partir da etapa "Configurar API") para concluir o processo.

Depois que a API é adicionada ao projeto, a página de visão geral do projeto exibe as seguintes credenciais necessárias em todas as chamadas para Experience Platform APIs:

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

Autenticação para cada sessão

A credencial final necessária que você deve coletar é sua {ACCESS_TOKEN}. Diferentemente dos valores para {API_KEY} e {IMS_ORG}, um novo token deve ser gerado a cada 24 horas para continuar usando Platform APIs.

Para gerar um novo {ACCESS_TOKEN}, siga as etapas para gerar um token JWT no guia de credenciais do Developer Console.

Testar credenciais de acesso

Depois de coletar as três credenciais necessárias, você pode tentar fazer a seguinte chamada de API. Esta chamada fará a lista de todas as classes Experience Data Model (XDM) no global container do Registro do Schema:

Formato da API

GET /global/classes

Solicitação

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

Resposta

Se sua resposta for semelhante à mostrada abaixo, suas credenciais serão válidas e estarão funcionando. (Essa resposta foi truncada para espaço.)

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

Usar o Postman para autenticação JWT e chamadas de API

O Postman é uma ferramenta popular para trabalhar com RESTful APIs. Esta publicação Média descreve como configurar o carteiro para executar automaticamente a autenticação JWT e usá-la para consumir APIs Adobe Experience Platform.

Próximas etapas

Ao ler este documento, você reuniu e testou com êxito suas credenciais de acesso para Platform APIs. Agora você pode seguir com as chamadas de API de exemplo fornecidas na documentação.

Além dos valores de autenticação que você coletou neste tutorial, muitas Platform APIs também exigem um valor válido {SANDBOX_NAME} para ser fornecido como cabeçalho. See the sandboxes overview for more information.

Nesta página