Configurar o Console do desenvolvedor e Postman

Última atualização em 2023-06-23
  • Tópicos
  • API
    Exibir mais informações sobre este tópico
  • Criado para:
  • Beginner
    Intermediate
    Developer

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

Para concluir os exercícios de API neste tutorial, baixe o aplicativo Postman para o 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 o 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.

Arquitetos de dados e Engenheiros de dados pode precisar usar a API da plataforma fora deste tutorial.

Permissões necessárias

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

Configurar o console do Adobe Developer

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 do App Builder. Você o usará para acessar a API Experience Platform. Para obter mais detalhes, consulte Documentação do console do Adobe Developer

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

  2. Abra o Console do Adobe Developer

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

  4. Selecionar Criar novo projeto in Início rápido menu.

    Criar novo projeto

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

  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 do projeto do console do Adobe Developer

  8. Selecionar Adicionar API

    Configuração da API do projeto do console do Adobe Developer

  9. Filtrar a lista selecionando Adobe Experience Platform

  10. Na lista de APIs disponíveis, selecione API EXPERIENCE PLATFORM e selecione Próxima.

    Configuração da API do projeto do console do Adobe Developer

  11. Selecionar Servidor OAuth para servidor como credencial e selecione Próxima.
    Selecionar servidor OAuth para servidor

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

    Selecionar perfil de produto

  13. Agora o projeto do Developer Console foi criado.

  14. No Experimente da página, selecione Baixar para Postman e selecione Servidor OAuth para servidor para baixar o Postman arquivo json do ambiente. Salve o oauth_server_to_server.postman_environment.json no seu Luma Tutorial Assets pasta.

    Configuração da API do projeto do console do Adobe Developer

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. A variável Nome da sua credencial de API (Credential in Luma Tutorial API Project)

  2. A variável Email da conta técnica da sua credencial (isso ajudará o Administrador do sistema a encontrar a credencial)

    Nome e Email da conta técnica da sua credencial

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

  1. Efetue logon no Adobe Experience Platform

  2. Selecionar Permissões na navegação à esquerda, que direcionará você para a Funções tela

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

  4. Selecione o Credenciais da API guia

  5. Selecionar Adicionar credenciais de API
    Adicionar credencial

  6. Localize o Credential in Luma Tutorial API Project credencial, filtragem com o Email da 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

ATENÇÃO

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. Abertura Postman e criar um espaço de trabalho
    Importar ambiente

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

  4. Entrada 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

A variável SANDBOX_NAME e TENANT_ID e CONTAINER_ID As variáveis não são incluídas na exportação do console do Adobe Developer, portanto, as adicionamos manualmente:

  1. Entrada Postman, abra o Variáveis de ambiente

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

  3. No Adicionar novo campo de variável, insira SANDBOX_NAME

  4. Em ambos os campos de valor, informe 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 Adicionar novo campo de variável, insira 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 do URL após o sinal @. Por exemplo, minha id de locatário é techmarketingdemos mas o seu é diferente:

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

  7. Copie esse valor e retorne ao campo Postman Tela Gerenciar ambientes

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

  9. No Adicionar novo campo de variável, insira CONTAINER_ID

  10. Enter global em ambos os campos de valor

    OBSERVAÇÃO

    CONTAINER_ID é um campo cujo valor alteramos várias vezes durante o tutorial. Quando global for usada, a API interagirá com elementos fornecidos pelo Adobe na sua conta da Platform. Quando tenant for usada, a API interagirá 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 a explorar a API do Experience Platform. Essas coleções estão no 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 o Coleção de APIs de serviço do Identity Management ao seu Luma Tutorial Assets pasta

  2. Importar a coleção para Postman

  3. Selecionar a solicitação oAuth: solicitar token de acesso solicitar e selecionar Enviar

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

    Solicitar os tokens

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

    Postman

Interagir com uma API da plataforma

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

Abra o Experience Platform Postman coleções 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 o Coleção de APIs do registro de esquema ao seu Luma Tutorial Assets pasta
  2. Importar para Postman
  3. Abertura API do registro de esquemas > Esquemas > Listar esquemas
  4. Olhe para o Params e Cabeçalhos e observe como elas incluem algumas das variáveis de ambiente inseridas anteriormente.
  5. Observe que Cabeçalhos > Aceitar campo de valor está definida como application/vnd.adobe.xed-id+json. As APIs do Registro de esquema exigem uma dessas valores do cabeçalho Aceitar especificados que fornecem diferentes formatos na resposta.
  6. Selecionar Enviar para fazer sua primeira chamada de API da plataforma!

Espero que você tenha tido sucesso 200 OK resposta 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 paralisado, 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 configurado, você está pronto para dados de modelo em esquemas!

Nesta página