DocumentaçãoExperience PlatformConfigurar o Developer Console e o Postman

Configurar o Developer Console e o Postman

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:
  • API

Criado para:

  • Iniciante
  • Intermediário
  • Desenvolvedor

Nesta lição, você configurará um projeto no Adobe Developer Console e baixará Postman coleções para poder começar a usar APIs da plataforma.

Para concluir os exercícios de API neste tutorial, baixe o aplicativo Postman para seu sistema operacional. Embora não seja necessário para usar APIs de Experience Platform, o Postman facilita os fluxos de trabalho de API, e o Adobe Experience Platform fornece dezenas de coleções do Postman para ajudar você a executar chamadas de API e saber como elas operam. O restante deste tutorial presume algum conhecimento prático do Postman. Para obter ajuda, consulte a documentação do Postman.

A Platform é criada como API. Embora as opções de interface também existam para todas as principais tarefas, você pode querer usar a API da plataforma em algum momento. Por exemplo, para assimilar dados, mover itens entre sandboxes, automatizar tarefas de rotina ou usar novos recursos da Platform antes que a interface do usuário tenha sido criada.

Talvez os Arquitetos de dados e os Engenheiros de dados precisem usar a API da plataforma fora deste tutorial.

Permissões necessárias

Na lição Configurar Permissões, você configura todos os controles de acesso necessários para concluir esta lição.

Configurar o Adobe Developer Console

O Adobe Developer Console é o destino do desenvolvedor para acessar APIs e SDKs do Adobe, ouvir eventos quase em tempo real, executar funções no tempo de execução ou criar plug-ins ou aplicativos App Builder. Você o usará para acessar a API Experience Platform. Para obter mais detalhes, consulte a documentação do Adobe Developer Console

  1. Crie uma pasta no computador local chamada Luma Tutorial Assets para arquivos usados no tutorial.

  2. Abra o Adobe Developer Console

  3. Faça logon e confirme se você está na organização correta

  4. Selecione Criar Novo Projeto no menu Início Rápido.

    Criar novo projeto

  5. No projeto recém-criado, selecione o botão Editar Projeto

  6. Altere o Título do Projeto para Luma Tutorial API Project (adicione seu nome ao final, se várias pessoas da sua empresa estiverem fazendo este tutorial)

  7. Selecione Salvar

    Configuração da API de projeto do Adobe Developer Console

  8. Selecione Adicionar API

    Configuração da API de projeto do Adobe Developer Console

  9. Filtre a lista selecionando Adobe Experience Platform

  10. Na lista de APIs disponíveis, selecione API de Experience Platform e selecione Avançar.

    Configuração da API de projeto do Adobe Developer Console

  11. Selecione OAuth Server-to-Server como a credencial e selecione Próximo.
    Selecionar servidor para servidor OAuth

  12. Selecione o perfil de produto AEP-Default-All-Users e selecione Salvar API configurada

    Selecionar Perfil de Produto

  13. Agora que seu projeto do Developer Console foi criado!

  14. Na seção Experimente da página, selecione Baixar para Postman e selecione Servidor para Servidor OAuth para baixar o arquivo json do ambiente Postman. Salve o oauth_server_to_server.postman_environment.json na pasta Luma Tutorial Assets.

    Configuração da API de projeto do Adobe Developer Console

Faça um administrador do sistema adicionar a credencial de API à função

Para usar a credencial de API para interagir com o Experience Platform, será necessário que um administrador do sistema atribua as credenciais de API à função criada na lição anterior. Caso você não seja um Administrador do sistema, envie-os:

  1. O Nome da credencial de API (Credential in Luma Tutorial API Project)

  2. O Email da Conta Técnica da sua credencial (isso ajudará o Administrador do Sistema a encontrar a credencial)

    Nome e Email de Conta Técnica da sua credencial

Estas são as instruções para o Administrador do sistema:

  1. Fazer logon no Adobe Experience Platform

  2. Selecione Permissões na navegação à esquerda, que o levará à tela Funções

  3. Abrir a função Luma Tutorial Platform
    Abrir a função

  4. Selecione a guia Credenciais da API

  5. Selecione Adicionar credenciais de API
    Adicionar credencial

  6. Encontre a credencial Credential in Luma Tutorial API Project, filtrando com o Email de Conta Técnica fornecido pelo participante do tutorial, se a lista for longa

  7. Selecionar a credencial

  8. Selecione Salvar

    Adicionar credencial

Configurar o Postman

CAUTION
A interface do Postman é atualizada regularmente. As capturas de tela neste tutorial foram feitas com o Postman v10.15.1 para Mac, mas as opções de interface podem ter sido alteradas.

  1. Baixar e instalar Postman

  2. Abrir Postman e criar um espaço de trabalho
    Importar ambiente

  3. Importar o arquivo de ambiente json baixado, oauth_server_to_server.postman_environment.json
    Importar ambiente

  4. Em Postman, selecione seu ambiente na lista suspensa

  5. Selecione o ícone para exibir as variáveis de ambiente:

    Alterar ambiente

Adicionar o nome da sandbox e a ID do locatário

As variáveis SANDBOX_NAME e TENANT_ID e CONTAINER_ID não estão incluídas na exportação do Adobe Developer Console, então elas são adicionadas manualmente:

  1. Em Postman, abra as Variáveis de Ambiente

  2. Selecione o link Editar à direita do nome do ambiente

  3. No campo Adicionar nova variável, digite SANDBOX_NAME

  4. Em ambos os campos de valor, insira luma-tutorial, o nome que demos à nossa sandbox na lição anterior. Se você usou um nome diferente para sua sandbox, por exemplo, luma-tutorial-ignatiusjreilly, certifique-se de usar esse valor.

  5. No campo Adicionar nova variável, digite TENANT_ID

  6. Alterne para o navegador da Web e procure a ID do locatário da sua empresa acessando a interface do Experience Platform e extraindo a parte da URL após o sinal @. Por exemplo, minha ID de locatário é techmarketingdemos, mas a sua é diferente:

    Obtendo a ID do locatário da URL da interface da plataforma

  7. Copiar este valor e retornar à tela Gerenciar Ambientes Postman

  8. Cole sua ID do locatário nos dois campos de valor

  9. No campo Adicionar nova variável, digite CONTAINER_ID

  10. Inserir global em ambos os campos de valor

    note note
    NOTE
    CONTAINER_ID é um campo cujo valor alteramos várias vezes durante o tutorial. Quando global é usado, a API interage com elementos fornecidos pelo Adobe na sua conta da Platform. Quando tenant é usado, a API interage com seus próprios elementos personalizados.

  11. Selecione Salvar

    Campos SANDBOX_NAME, TENANT_ID e CONTAINER_ID adicionados como variáveis de ambiente

Fazer chamadas de API

Recuperar um token de acesso

O Adobe fornece um conjunto avançado de Postman coleções para ajudar você a explorar a API de Experience Platform. Essas coleções estão no repositório GitHub de Exemplos do Adobe Experience Platform Postman. Você deve marcar este repositório como você usará isso várias vezes neste tutorial e posteriormente ao implementar o Experience Platform para sua própria empresa.

A primeira coleção funciona com as APIs do Adobe Identity Management Service (IMS). É uma maneira conveniente de recuperar um token de acesso de dentro do Postman.

Para gerar o token de acesso:

  1. Baixe a coleção de APIs de serviço do Identity Management na pasta Luma Tutorial Assets

  2. Importar a coleção para Postman

  3. Selecione a solicitação oAuth: Solicitar Token de Acesso e selecione Enviar

  4. Você deve obter uma resposta 200 OK com um token de acesso na resposta

    Solicitar os tokens

  5. O token de acesso deve ser armazenado automaticamente como a variável de ambiente ACCESS_TOKEN do ambiente Postman.

    Postman

Interagir com uma API da plataforma

Agora vamos fazer uma chamada à API da plataforma para confirmar se configuramos tudo corretamente.

Abra as coleções Experience Platform Postman no GitHub. Há muitas coleções nesta página, para várias APIs da plataforma. Eu recomendo fortemente marcá-lo.

Agora, vamos fazer nossa primeira chamada de API:

  1. Baixe a coleção de APIs do Registro de Esquema na pasta Luma Tutorial Assets
  2. Importar para Postman
  3. Abra API do Registro de Esquemas > Esquemas > Listar esquemas
  4. Examine as guias Params e Headers e observe como elas incluem algumas das variáveis de ambiente inseridas anteriormente.
  5. Observe que o campo de valor Cabeçalhos > Aceitar está definido como application/vnd.adobe.xed-id+json. As APIs do Registro de Esquema exigem um destes valores do cabeçalho Aceitar especificados, que fornecem formatos diferentes na resposta.
  6. Selecione Enviar para fazer sua primeira chamada de API da plataforma!

Esperamos que você tenha uma resposta 200 OK bem-sucedida contendo uma lista dos esquemas XDM fornecidos pelo Adobe disponíveis em sua sandbox, como mostrado abaixo.

Primeira chamada de API no Postman

Se a chamada não tiver sido bem-sucedida, aguarde um pouco para depurar usando os detalhes de resposta de erro da chamada da API e revise as etapas acima. Se você ficar preso, solicite ajuda no Fórum da Comunidade ou use o link no lado direito desta página para "Registrar um problema".

Com suas permissões da Platform, sandbox e Postman configuradas, você está pronto para modelar dados em esquemas!

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad