Configurar autenticação para APIs do Adobe Target

As APIs de administrador do Adobe Target, incluindo Recommendations APIs de administrador, são protegidas por autenticação para garantir que somente usuários autorizados as usem para acessar o Adobe Target. Use o Console do Desenvolvedor do Adobe para gerenciar essa autenticação para todas as soluções da Adobe Experience Cloud, incluindo Target.

Esta lição aborda as etapas preliminares necessárias para gerar tokens de autenticação necessários para interagir com as APIs do Adobe Target com êxito. Nas seções a seguir, você:

  1. Crie um projeto (anteriormente chamado de integração) no Console do desenvolvedor do Adobe.
  2. Exporte detalhes do projeto para o Postman.
  3. Gere um token de acesso ao portador.
  4. Teste o token de acesso do portador.

Pré-requisitos

Recurso Detalhes
Postman Para concluir essas etapas com sucesso, obtenha o Aplicativo Postman para seu sistema operacional. O Postman Basic é gratuito com a criação de contas. Embora não seja necessário para usar as APIs do Adobe Target em geral, o Postman facilita os fluxos de trabalho da API e o Adobe Target fornece várias coleções de Postman para ajudar a executar suas APIs e aprender como elas operam. O resto deste tutorial assume conhecimento prático de Postman. Para obter ajuda, consulte a documentação do Postman.
Referências A familiarização com os seguintes recursos é assumida no restante deste tutorial:

Criar um projeto do Adobe I/O

Nesta seção, você acessará o Console do desenvolvedor do Adobe e criará um projeto para Adobe Target. Para obter mais informações, consulte a documentação sobre projetos.

  1. No Adobe Admin Console, verifique se sua conta de usuário do Adobe recebeu acesso ao nível Administrador de produto e Desenvolvedor para Target.

  2. No Console do Desenvolvedor do Adobe, selecione a Organização do Experience Cloud para a qual deseja criar essa integração. (Observe que é provável que você só tenha acesso a uma única organização do Experience Cloud.)

    configure-io-target-create-project2.png

  3. Clique em Criar novo projeto.

    configure-io-target-create-project3.png

  4. Clique em Adicionar API para adicionar uma REST API ao seu projeto para acessar serviços e produtos da Adobe.

    Adicionar API

  5. Selecione Adobe Target como o serviço da Adobe com o qual deseja integrar. Clique no botão Next que aparece.

    configure-io-target-create-project5

  6. Selecione uma opção para associar chaves públicas e privadas à integração da conta de serviço que você está criando para o Target. Para este tutorial, selecione Opção 1: Gere um par de chaves e clique em Generate keypair.
    configure-io-target-create-project6

  7. Observe os resultados! Conforme instruído, anote o arquivo de configuração baixado automaticamente (config), que contém a chave privada. Clique em Avançar.
    configure-io-target-create-project7

  8. No sistema de arquivos, verifique o local de config, que é o arquivo de configuração compactado criado na etapa anterior. Novamente, esse arquivo config contém sua chave privada, que será necessária posteriormente. A localização exata em seu sistema de arquivos pode diferir da mostrada aqui.
    configure-io-target-create-project8

  9. De volta ao Console do desenvolvedor do Adobe, selecione os perfis de produto correspondentes às propriedades em que você está usando Recommendations. (Se não estiver usando propriedades, selecione a opção Espaço de trabalho padrão.) Clique em Salvar API configurada.
    configure-io-target-create-project9

  10. Clique em Criar integração. Você deve receber uma mensagem temporária indicando que sua API foi configurada com êxito.

  11. Como etapa final, renomeie seu projeto com um nome mais significativo do que o Project 1 original. Para fazer isso, navegue até o projeto usando o caminho de navegação como mostrado, clique em Editar projeto para acessar o modal **Editar projeto e renomeie o projeto.

configure-io-target-create-project11

OBSERVAÇÃO

Neste tutorial, nomeamos o projeto como "Integração do Target". Se você desejar usar o projeto para mais do que apenas o Adobe Target, convém nomeá-lo adequadamente. Por exemplo, você pode optar por nomeá-lo como "APIs do Adobe" ou "APIs do Experience Cloud", já que ele pode ser usado com outras soluções na Adobe Experience Cloud.

Exportar detalhes do projeto

Agora que você tem um projeto do Adobe que pode usar para acessar Target, é necessário enviar detalhes desse projeto junto com as solicitações da API do Adobe. Esses detalhes são necessários para interagir com várias APIs do Adobe, incluindo várias Target APIs. Por exemplo, os detalhes de integração incluem informações de autorização e autenticação exigidas pelas Target APIs de administração. Portanto, para usar as APIs com o Postman, é necessário inserir esses detalhes no Postman.

Há muitas maneiras de especificar os detalhes do seu projeto no Postman, mas nesta seção, aproveitamos alguns recursos e coleções pré-construídos. Primeiro (nesta seção), você exportará os detalhes da sua integração para um ambiente Postman. Em seguida (na seção a seguir), você gerará um token de acesso do portador para conceder acesso aos recursos de Adobe necessários.

OBSERVAÇÃO

Para obter instruções de vídeo aplicáveis a qualquer solução de Experience Cloud, incluindo Target, consulte Usar Postman com APIs de Experience Platform. As seguintes seções são relevantes para as APIs Target:

  1. Exportar detalhes de integração do Adobe I/O para o Postman
  2. Gerar um token de acesso com o Postman

Essas etapas também são fornecidas abaixo.

  1. Ainda no Console do Desenvolvedor do Adobe, navegue para exibir as credenciais Conta de Serviço (JWT) do seu novo projeto. Use a navegação à esquerda ou a seção Credenciais, conforme mostrado.
    JWT1
    Em detalhes de Credencial, observe que você pode visualizar suas chaves públicas, a ID do cliente e outras informações relacionadas à sua conta de serviço.
    JWT1a

  2. Clique em para navegar até as informações sobre a API Adobe Target. Use a navegação à esquerda ou a seção Connected products and services, conforme mostrado.
    JWT2

  3. Clique em Baixar para Postman > Conta de serviço (JWT) para criar um arquivo JSON capturando suas informações de autenticação para um ambiente Postman.
    JWT3
    Anote o arquivo JSON em seu sistema de arquivos.
    JWT3a

  4. No Postman, clique no ícone de engrenagem para gerenciar seus ambientes e clique em Importar para importar o arquivo JSON (ambiente).
    JWT4

  5. Escolha seu arquivo e clique em Open.
    JWT5

  6. No modal Postman Gerenciar ambientes, clique no nome do ambiente recém-importado para inspecioná-lo. (O nome do ambiente pode ser diferente do mostrado aqui. Edite o nome conforme desejado. Ela não precisa necessariamente corresponder ao nome do Adobe project.)
    JWT6

  7. Observe que CLIENT_SECRET e API_KEY (juntamente com outras variáveis) têm seus valores preenchidos previamente, obtidos da integração, conforme definido no Console do desenvolvedor do Adobe. (A variável Postman CLIENT_SECRET deve corresponder à credencial de Adobe CLIENT SECRET, conforme exibida no Console do desenvolvedor, e API_KEY no Postman também deve corresponder a CLIENT ID no Console do desenvolvedor.) Por outro lado, as notas PRIVATE_KEY, JWT_TOKEN e ACCESS_TOKEN estão em branco. Vamos começar fornecendo o valor PRIVATE_KEY.
    JWT7

    OBSERVAÇÃO

    Surpresa!

    Teste de pop! Você consegue se lembrar onde está sua chave privada?
    Está certo, está no arquivo config baixado anteriormente do Console do Desenvolvedor do Adobe!

  8. No sistema de arquivos, abra o arquivo config e abra o arquivo de chave private.
    JWT8

  9. Selecione e copie todo o conteúdo do arquivo de chave private.
    JWT9

  10. No Postman, cole o valor da chave privada nos campos VALOR INICIAL e VALOR ATUAL.
    JWT10

  11. Clique em Atualizar e feche o modal Ambientes.

Gerar o token de acesso do portador

Nesta seção, você gera o token de acesso do portador, que é necessário para autenticar sua interação com APIs do Adobe Target. Para gerar o token de acesso do portador, é necessário enviar os detalhes de integração (estabelecidos nas seções anteriores) para o Adobe Identity Management Service (IMS). Há algumas maneiras diferentes de fazer isso, mas neste tutorial, criamos uma solicitação de POST bespoke para a API IMS. Só brincando. Neste tutorial, aproveitamos uma coleção Postman contendo uma chamada IMS pré-criada que torna o processo direto e fácil. Depois de importar a coleção, você pode reutilizá-la sempre que necessário para gerar novos tokens não apenas para o Adobe Target, mas também para outras APIs do Adobe.

  1. Navegue até o Adobe Identity Management Service API de exemplo de chamadas.
    token1

  2. Clique na coleção Postman de geração de token de acesso ao Adobe I/O.
    token2

  3. Obtenha o JSON bruto para esta coleção clicando em Raw e copiando o JSON resultante para a área de transferência. (Como alternativa, você pode salvar o JSON bruto como um arquivo .json.)
    token3

  4. No Postman, importe a coleção colando e enviando o JSON bruto da área de transferência. (Como alternativa, você pode fazer upload do arquivo .json que você salvou.) Clique em Continuar.
    token4

  5. Selecione o IMS: Gerar JWT + Auth por meio de solicitação de Token de usuário na coleção Postman de geração de token de acesso ao Adobe I/O, verifique se o ambiente está selecionado e clique em Enviar para gerar o token.

    token5

    OBSERVAÇÃO

    Esse token de acesso do portador será válido por 24 horas. Envie a solicitação novamente sempre que precisar gerar um novo token.

  6. Abra o modal Gerenciar ambientes novamente e selecione o ambiente.
    token6

  7. Observe que os valores ACCESS_TOKEN e JWT_TOKEN agora estão preenchidos.
    token7

OBSERVAÇÃO

P: Preciso usar a coleção Postman de geração de token de acesso ao Adobe I/O para gerar o JSON Web Token (JWT) e o token de acesso do portador?

A: Não! A coleção Adobe I/O Access Token Generation Postman está disponível como uma conveniência para gerar mais facilmente o JWT e o token de acesso ao portador no Postman. Como alternativa, você pode usar recursos no Console do desenvolvedor do Adobe para gerar manualmente o token de acesso do portador.

Teste o token de acesso do portador

Neste exercício, você usará seu novo token de acesso do portador enviando uma solicitação de API que recupera uma lista de atividades da sua conta Target. Uma resposta bem-sucedida indica que o projeto do Adobe e a autenticação estão funcionando como esperado para usar a API.

  1. Importe as APIs de administrador do Adobe Target Postman Collection. Siga todos os prompts até que a coleção seja importada no Postman.
    testtoken1

  2. Expanda a coleção e observe a solicitação List activities.
    testtoken1

  3. Observe que variáveis como {{access_token}} estão inicialmente por resolver. Você pode resolver isso de várias maneiras diferentes, por exemplo, você pode definir uma nova variável de coleção chamada {{access_token}}, mas neste tutorial, você alterará a solicitação da API para aproveitar o ambiente Postman que estava usando anteriormente. Isso permitirá que o ambiente continue a servir como uma consolidação única e consistente de todas as variáveis comuns entre as APIs do Adobe.
    testtoken2

  4. Digite para substituir {{access_token}} por {{ACCESS_TOKEN}}.
    testtoken3

  5. Digite para substituir {{api_key}} por {{API_KEY}}.
    testtoken4

  6. Digite para substituir {{tenant}} por {{TENANT_ID}}. Observação {{TENANT_ID}} ainda não foi reconhecida.
    testtoken4

  7. Abra o modal Gerenciar ambientes e selecione o ambiente.
    JWT11

  8. Digite para adicionar uma nova variável de ambiente {{TENANT_ID}}. Copie e cole o valor da ID do locatário nos campos VALOR INICIAL e VALOR ATUAL para a nova variável de ambiente TENANT_ID.

    testtoken5

    OBSERVAÇÃO

    A ID do locatário é diferente de seu Target clientcode. A ID do locatário existe no URL quando você está conectado a Target. Para obter sua ID do locatário, faça logon no Adobe Experience Cloud, abra Target e clique no cartão Target. Use o valor da ID do locatário, conforme observado no subdomínio do URL.

    Por exemplo, se o URL quando conectado ao Adobe Target for

    <https://mycompany.experiencecloud.adobe.com/...>

    então sua ID do locatário é "minha empresa".

  9. Envie sua solicitação após verificar se você selecionou o ambiente correto. Você deve receber uma resposta contendo sua lista de atividades.
    testtoken6

Parabéns! Depois de verificar a autenticação do Adobe, é possível usá-la para interagir com as APIs do Adobe Target (bem como com outras APIs do Adobe). Por exemplo, você pode Usar APIs do Recommendations para criar ou gerenciar recomendações.

Nesta página