Configurar autenticação para Adobe Target APIs

A variável Adobe Target APIs de administrador, incluindo Recommendations Admin As APIs são protegidas por autenticação para garantir que somente usuários autorizados as usem para acessar o Adobe Target. Use o Console do Adobe Developer para gerenciar esta autenticação para todos Adobe Experience Cloud solutions, incluindo 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 Migração da credencial de conta de serviço (JWT) para a credencial de servidor para servidor do OAuth no Console do desenvolvedor documentação.
Para obter informações sobre como configurar novas credenciais do OAuth, consulte Implementação de credencial de servidor para servidor OAuth no Console do desenvolvedor documentação.

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

  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 o seu sistema operacional. O Postman Basic é gratuito com a criação da conta. Embora não seja necessário para usar o Adobe Target APIs em geral, o Postman facilita os fluxos de trabalho de API e Adobe Target O fornece várias coleções do Postman para ajudar a executar suas APIs e saber como elas operam. O restante deste guia pressupõe conhecimento prático do Postman. Para obter ajuda, consulte 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á o Adobe Developer Console e criar um projeto para Adobe Target. Para obter mais informações, consulte a documentação sobre projetos.

<!—(1. Gerar sua chave privada e certificado público, de acordo com documentação sobre autenticação. // [//]: # (conforme descrito em 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 private.key arquivo e um certificate_pub.crt arquivo. Retorne a este guia após gerar os dois arquivos.)—>

  1. No Adobe Admin Console, garanta o seu Adobe a conta do usuário foi concedida Administrador do produto e Desenvolvedor nível de acesso a Target.

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

    configure-io-target-createproject2.png

  3. Clique em Criar novo projeto.

    configure-io-target-createproject3.png

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

    Adicionar API

  5. Selecionar Adobe Target como o Adobe com o qual você deseja integrar. Clique em Próxima 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 para a qual você está criando Target. Para este exemplo, selecione Opção 1: gerar um par de chaves e clique em Gerar par de chaves.

    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 Avançar.

    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, isso config O arquivo 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 ao Console do Adobe Developer, selecione a perfil(is) de produto correspondente às propriedades nas quais você está usando o Adobe 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-createproject9

  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 original Project 1. Para fazer isso, navegue até o projeto usando o caminho de navegação como mostrar, clique em Editar projeto para acessar o Editar Projeto e renomeie o projeto.

    configure-io-target-createproject11

NOTE
Neste exemplo, nomeamos nosso projeto como "Target Integração." Se você prevê usar seu projeto para mais do que apenas Adobe Target, convém nomeá-lo de acordo. 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, pode usar para acessar o Target, você precisa 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 de Adobe, incluindo várias Target APIs. Por exemplo, os detalhes da integração incluem informações de autorização e autenticação exigidas pelo 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 Uso do Postman com APIs Experience Platform. As seguintes seções são relevantes para o Target APIs: 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 Console do Adobe Developer, navegue para visualizar as configurações do novo Conta de serviço (JWT) credenciais. Use a navegação à esquerda ou a Credenciais conforme mostrado.

    JWT1

    Entrada Detalhes da credencial, observe que você pode visualizar suas Chave(s) pública(s), ID do cliente e outras informações relacionadas à sua conta de serviço.

    JWT1a

  2. Clique para acessar as informações sobre o Adobe Target API. Use a navegação à esquerda ou a Produtos e serviços conectados 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

    Observe o arquivo JSON no seu sistema de arquivos.

    JWT3a

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

    JWT4

  5. Escolha o arquivo e clique em Abertura.

    JWT5

  6. No 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. Não é necessário necessariamente corresponder ao nome do Adobe projeto.)

    JWT6

  7. Nota CLIENT_SECRET e API_KEY (juntamente com outras variáveis) têm seus valores pré-preenchidos, obtidos da sua integração, conforme definido no Console do Adobe Developer. (O Postman CLIENT_SECRET deve corresponder ao CLIENT SECRET a credencial do Adobe conforme exibida no Console do desenvolvedor e API_KEY no Postman também devem corresponder CLIENT ID no Console do desenvolvedor.) Em contrapartida, PRIVATE_KEY, JWT_TOKEN, e ACCESS_TOKEN estão em branco. Vamos começar fornecendo o PRIVATE_KEY valor.

    JWT7

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

    JWT8

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

    JWT9

  10. No Postman, cole seu valor de chave privada no VALOR INICIAL e VALOR ATUAL campos.

    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 o Adobe Target APIs. 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 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 outras APIs de Adobe.

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

    token1

  2. Clique em Coleção Adobe I/O Access Token Generation Postman.

    token2

  3. Obtenha o JSON bruto para esta coleção clicando em Brutos, 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 Continuar.

    token4

  5. Selecione o IMS: Geração JWT + autenticação via token de usuário na coleção Adobe I/O Access Token Generation Postman, certifique-se de que seu ambiente está selecionado e clique em Enviar 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 ACCESS_TOKEN e JWT_TOKEN Os valores de agora sã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 Console do Adobe Developer 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 do Target conta. Uma resposta bem-sucedida indica que Adobe O projeto e a autenticação estão funcionando como esperado para usar a API.

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

    testtoken1

  2. Expanda a coleção e observe o Listar atividades solicitação.

    testtoken1

  3. Observe que variáveis como {{access_token}} não são resolvidos inicialmente. Isso pode ser resolvido de várias maneiras diferentes, por exemplo, você pode 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}} com {{ACCESS_TOKEN}}.

    testtoken3

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

    testtoken4

  6. Digite para substituir {{tenant}} com {{TENANT_ID}}. Nota {{TENANT_ID}} ainda não foi reconhecido.

    testtoken4

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

    JWT11

  8. Digite para adicionar um novo {{TENANT_ID}} variável de ambiente. Copie e cole seu valor de ID de locatário no VALOR INICIAL e VALOR ATUAL campos para o novo TENANT_ID variável de ambiente.

    testtoken5

    note note
    NOTE
    A ID do locatário é diferente da Target clientcode. A ID do locatário existe na URL quando você está conectado ao Target. Para obter sua ID de locatário, faça logon na Adobe Experience Cloud, abra Targete clique no cartão Direcionamento. Use o valor da ID do locatário conforme observado no subdomínio do URL. Por exemplo, se o URL ao fazer logon no Adobe Target é <https://mycompany.experiencecloud.adobe.com/...> em seguida, a ID do locatário é "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 Adobe, é possível usá-la para interagir com o Adobe Target APIs (bem como outras APIs de Adobe). Por exemplo, você pode Uso de APIs do Recommendations para criar ou gerenciar recomendações, ou você pode usá-las com o API de entrega do Target.

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