Configurar autenticação para Adobe Target APIs

As APIs de Administrador Adobe Target, incluindo as APIs Recommendations Admin, são protegidas por autenticação para garantir que somente usuários autorizados as usem para acessar Adobe Target. Use o Adobe Developer Console para gerenciar esta autenticação para todos os Adobe Experience Cloud solutions, incluindo o Adobe Target.

IMPORTANT
As credenciais da Conta de serviço (JWT) descritas neste artigo serão substituídas em favor das novas credenciais de servidor para servidor do OAuth.
As credenciais da Conta de serviço (JWT) continuarão a funcionar até 1º de janeiro de 2025. Você deve migrar seu aplicativo ou integração para usar a nova credencial OAuth de servidor para servidor antes de 1º de janeiro de 2025.
Para obter mais informações e instruções passo a passo para migrar sua integração, consulte Migrando da credencial de Conta de Serviço (JWT) para a credencial de servidor para servidor OAuth na documentação do Developer Console.
Para obter informações sobre como configurar novas credenciais do OAuth, consulte a implementação de credenciais de servidor para servidor do OAuth na documentação do Developer Console.

Estas são as etapas preliminares necessárias para gerar os tokens de autenticação JWT herdados necessários para interagir com êxito com as APIs do Adobe Target:

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

Pré-requisitos

Recurso
Detalhes
Postman
Para concluir essas etapas com êxito, obtenha o aplicativo Postman para seu sistema operacional. O Postman Basic é gratuito com a criação da conta. Embora não seja necessário para usar APIs do Adobe Target em geral, o Postman facilita os fluxos de trabalho da API e o Adobe Target fornece várias coleções do Postman para ajudar a executar suas APIs e aprender como elas operam. O restante deste guia pressupõe conhecimento prático do Postman. Para obter ajuda, consulte a documentação do Postman.
Referências

Familiaridade com os seguintes recursos é presumida no restante deste guia:

Criar um projeto Adobe I/O

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

<!—(1) Gere sua chave privada e certificado público, de acordo com a documentação sobre autenticação. // [//]: # (conforme descrito na Etapa 1 de Como configurar o Adobe IO: Autenticação - Passo a Passo. Depois de concluir a Etapa 1, retorne a este guia e retome com a Etapa 2 abaixo. // O resultado desta etapa deve ser a criação de um arquivo private.key e um arquivo certificate_pub.crt. Retorne a este guia após gerar os dois arquivos.)—>

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

  2. No Adobe Developer Console, selecione o Experience Cloud Organization para o qual deseja criar essa integração. (Observe que é provável que você só tenha acesso a um único Experience Cloud Organization.)

    configure-io-target-createproject2.png

  3. Clique em Create new project.

    configure-io-target-createproject3.png

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

    Adicionar API

  5. Selecione Adobe Target como o serviço Adobe ao qual você deseja integrar. Clique no botão Next que aparece.

    configure-io-target-createproject5

  6. Selecione uma opção para associar chaves públicas e privadas à integração de conta de serviço que você está criando para Target. Para este exemplo, selecione Option 1: Generate a key pair e clique em Generate keypair.

    configure-io-target-createproject6

  7. Conforme instruído, anote o arquivo de configuração baixado automaticamente (config), que contém sua chave privada. Clique em Next.

    configure-io-target-createproject7

  8. Em seu 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. O local exato em seu sistema de arquivos pode ser diferente do mostrado aqui.

    configure-io-target-createproject8

  9. De volta à Adobe Developer Console, selecione o(s) perfil(is) de produto correspondente(s) às propriedades nas quais você está usando o Adobe Recommendations. (Se você não estiver usando propriedades do, selecione a opção Workspace padrão.) Clique em Save configured API.

    configure-io-target-createproject9

  10. Clique em Create Integration. 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 que o Project 1 original. Para fazer isso, navegue até o projeto usando o caminho de navegação como mostrar, clique em Edit project para acessar o modal Edit Project e renomeie o projeto.

    configure-io-target-createproject11

NOTE
Neste exemplo, nomeamos nosso projeto como Integração "Target". Se você prevê usar seu projeto para mais do que apenas Adobe Target, talvez queira nomeá-lo adequadamente. Por exemplo, você pode optar por nomeá-lo como "APIs de Adobe" ou "APIs de Experience Cloud", pois ele pode ser usado com outras soluções na Adobe Experience Cloud.

Exportar detalhes do projeto

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

Há várias maneiras de especificar os detalhes do seu projeto no Postman, mas nesta seção, aproveitamos alguns recursos e coleções pré-criados. Primeiro (nesta seção), você exportará os detalhes da sua integração em um ambiente do 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.

NOTE
Para obter instruções de vídeo aplicáveis a qualquer solução de Experience Cloud, incluindo Target, consulte Usar o Postman com APIs de Experience Platform. As seguintes seções são relevantes para as APIs do Target: 1. Crie e exporte a API de Experience Platform para o Postman 2. Gerar um token de acesso com o Postman. Essas etapas também são fornecidas abaixo.
  1. Ainda no Adobe Developer Console, navegue para exibir as credenciais Service Account (JWT) do novo projeto. Use a navegação à esquerda ou a seção Credentials, como mostrado.

    JWT1

    Em Credential details, observe que você pode visualizar Public key(s), Client ID e outras informações relacionadas à sua conta de serviço.

    JWT1a

  2. Clique para acessar as informações sobre a API Adobe Target. Use a navegação à esquerda ou a seção Produtos e serviços conectados como mostrado.

    JWT2

  3. Clique em Download for Postman > Service Account (JWT) para criar um arquivo JSON capturando suas informações de autenticação para um ambiente Postman.

    JWT3

    Observe o arquivo JSON no seu sistema de arquivos.

    JWT3a

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

    JWT4

  5. Escolha seu arquivo e clique em Open.

    JWT5

  6. No modal Gerenciar ambientes do Postman, 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. Ele não precisa necessariamente corresponder ao nome do projeto Adobe.)

    JWT6

  7. Os valores de CLIENT_SECRET e API_KEY (juntamente com outras variáveis) foram preenchidos previamente a partir da sua integração, conforme definido na Adobe Developer Console. (A variável CLIENT_SECRET do Postman deve corresponder à credencial de Adobe CLIENT SECRET conforme exibida no Developer Console, e API_KEY no Postman também deve corresponder a CLIENT ID no Developer Console.) Por outro lado, a observação PRIVATE_KEY, JWT_TOKEN e ACCESS_TOKEN estão em branco. Vamos começar fornecendo o valor PRIVATE_KEY.

    JWT7

  8. Em seu 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 seu valor de chave privada nos campos INITIAL VALUE e CURRENT VALUE.

    JWT10

  11. Clique em Update 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 Adobe Target. Para gerar o token de acesso do portador, é necessário enviar os detalhes da integração (estabelecidos nas seções anteriores) ao Adobe Identity Management Service (IMS). Há algumas maneiras diferentes de fazer isso, mas neste guia aproveitamos uma coleção do Postman que contém 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 Adobe Target, mas também para outras APIs de Adobe.

  1. Navegue até o Adobe Chamadas de amostra da API de serviço do Identity Management.

    token1

  2. Clique no Adobe I/O Access Token Generation Postman collection.

    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 salvo.) Clique em Continue.

    token4

  5. Selecione a solicitação IMS: JWT Generate + Auth via User Token na coleção Adobe I/O Access Token Generation Postman, verifique se o ambiente está selecionado e clique em Send para gerar o token.

    token5

    note note
    NOTE
    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 seu ambiente.

    token6

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

    token7

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

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

Testar o token de acesso do portador

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

  1. Importe a Adobe Target Coleção de Postman de APIs de administrador. 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}} não são resolvidas inicialmente. Você poderia resolver isso de várias maneiras diferentes, por exemplo, você poderia definir uma nova variável de coleção chamada {{access_token}}, mas neste guia, você alterará a solicitação da API para aproveitar o ambiente do 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 nas APIs do Adobe.

    testtoken2

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

    token de teste3

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

    testtoken4

  6. Digite para substituir {{tenant}} por {{TENANT_ID}}. A nota {{TENANT_ID}} ainda não foi reconhecida.

    testtoken4

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

    JWT11

  8. Digite para adicionar uma nova variável de ambiente {{TENANT_ID}}. Copie e cole seu valor de ID de locatário nos campos INITIAL VALUE e CURRENT VALUE para sua nova variável de ambiente TENANT_ID.

    token de teste5

    note note
    NOTE
    A ID do Locatário é diferente de seu Target clientcode. A ID do Locatário existe na URL quando você está conectado a Target. Para obter sua ID de Locatário, faça logon na Adobe Experience Cloud, abra o Target e clique no cartão de Destino. Use o valor da ID do locatário conforme observado no subdomínio do URL. Por exemplo, se a URL ao fazer logon no Adobe Target for <https://mycompany.experiencecloud.adobe.com/...>, sua ID de Locatário será "mycompany".
  9. Envie sua solicitação depois de verificar se você selecionou o ambiente correto. Você deve receber uma resposta contendo sua lista de atividades.

    testtoken6

Agora que você verificou a autenticação de Adobe, é possível usá-la para interagir com as APIs do Adobe Target (bem como com outras APIs de Adobe). Por exemplo, você pode Usar APIs do Recommendations para criar ou gerenciar recomendações, ou pode usá-las com a API de Entrega do Target.

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3