Este guia aborda as APIs do Adobe Customer Journey Analytics (CJA), detalhando a extração de dados, as soluções personalizadas e a integração de terceiros. Ele inclui configuração de acesso, chaves de API, testes com o Postman, um exemplo passo a passo da chamada de API e dicas para novos usuários.
Você ainda não conhece bem as APIs e está se perguntando como as APIs do Adobe Customer Journey Analytics (CJA) podem ajudá-lo? Não tema! Neste guia para iniciantes, abordamos os aspectos essenciais, analisamos os jargões e ajudamos você a dar os primeiros passos no mundo empolgante das APIs do CJA.
Imagine ter o poder de acessar e analisar os dados do CJA de forma programática, sem esforço manual. É exatamente isso que as APIs do CJA permitem que você faça.
- Extrair dados com eficiência: agilize a extração de dados com chamadas de API.
- Crie soluções personalizadas: projete e implemente pipelines de relatórios automatizados adaptados às necessidades específicas do negócio.
- Conecte-se de forma simples: habilite um fluxo de dados contínuo entre o CJA e os aplicativos de terceiros por meio de integrações robustas.
Pense nas APIs como mensageiras: elas carregam suas solicitações para os servidores da Adobe e trazem os resultados em um pacote perfeito.
Preparando-se para o sucesso
Antes de fazer sua primeira chamada de API, será necessário configurar o acesso e as permissões adequadas. Primeiro, verifique se você foi adicionado como um Desenvolvedor da organização. Em seguida, verifique se você tem acesso aos perfis de produto com as permissões necessárias.
Etapa 1: obter sua chave de API
- Faça logon no Adobe Developer Console.
- Crie um novo projeto e adicione a API do Customer Journey Analytics ao seu projeto e selecione os perfis de produto necessários.
- Clique em Adicionar ao projeto e adicione também a API do Adobe Experience Platform ao projeto
- Depois que a instalação for concluída, você poderá obter todas as informações necessárias na guia Credenciais à esquerda.
Estes são os três parâmetros essenciais de cabeçalho necessários para todas as solicitações de API
- Token de acesso: garante que somente usuários autorizados acessem os dados e pode ser gerado clicando no CTA Gerar token de acesso realçado na captura de tela. Ele é referido como parâmetro de Autorização na solicitação de API
- ID do cliente: também conhecida como Chave de API, é referida como x-api-key na solicitação de API
- ID da organização: referida como x-gw-ims-org-id na solicitação de API
Salve essas credenciais, elas são as chaves para desbloquear o poder da API. Na seção Introdução da API do CJA, você encontrará instruções passo a passo mais detalhadas.
Etapa 2: testar sua configuração
Uma ótima maneira de testar APIs sem escrever nenhum código é usar o Postman, uma ferramenta eficiente e fácil de usar. Depois de iniciar o aplicativo, você pode importar facilmente suas credenciais de API e começar a experimentar com solicitações simples do GET para verificar se sua conexão e autenticação estão funcionando corretamente. É recomendável iniciar a jornada de teste da API com solicitações do GET, pois elas são consideradas mais seguras e não destrutivas, pois apenas recuperam dados do servidor sem fazer modificações. Isso está em contraste com outros métodos HTTP, como solicitações POST, PUT ou DELETE, que podem alterar ou remover dados no servidor e, portanto, devem ser testados com mais cuidado.
Elaboração da sua primeira chamada se API
Vamos fazer algo simples: busque uma lista de visualizações de dados disponíveis em sua conta do CJA.
Exemplo: listar visualizações de dados
Ponto de acesso:
GET https://cja.adobe.io/data/dataviews
Cabeçalhos:
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG_ID}
Authorization: Bearer {AUTHORIZATION_TOKEN}
Solicitação CURL:
curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\
-H "x-api-key: {API_KEY}" \
-H "x-gw-ims-org-id: {IMS_ORG_ID}" \
-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"
Você também pode testar essas solicitações na documentação do ponto de acesso da API do CJA usando o recurso Testar. Este é o link para testar a solicitação acima.
Basta clicar no CTA Testar e inserir todos os parâmetros obrigatórios, nesse caso, os parâmetros de cabeçalho que discutimos, e clicar em Enviar.
Você também pode incluir parâmetros adicionais para personalizar sua solicitação. Uma lista de parâmetros disponíveis pode ser encontrada na seção Parâmetros de consulta para cada solicitação de API na documentação da API do CJA.
Estes são os principais códigos de resposta HTTP que você encontrará ao trabalhar com APIs:
- 200: Sucesso — O servidor processou com êxito a solicitação e retornou dados
- 404: Não encontrado — o servidor não pôde localizar o recurso solicitado
- 500: Erro interno do servidor — Erro no lado do servidor
Esses códigos de status informam aos desenvolvedores exatamente o que aconteceu durante uma solicitação de API, facilitando a solução de problemas.
Dicas para novos usuários da API
- Verifique seu acesso: verifique se você tem os níveis corretos de permissões e se foi adicionado aos perfis de produto corretos. Não ter o acesso correto é a causa principal mais comum para solicitações de API malsucedidas
- Teste, teste e teste mais um pouco: use o recurso Testar na documentação do ponto de acesso de API ou no Postman para testar as solicitações antes de escrever o código.
- Comece devagar: comece com solicitações GET simples e vá progredindo até chegar a consultas POST.
- Use a documentação: a documentação da API do CJA da Adobe é sua melhor amiga. Verifique regularmente se há atualizações, pois configurações mais antigas podem não funcionar conforme esperado após atualizações importantes.
- Faça perguntas: não hesite em entrar em contato com a Comunidade Adobe Analytics da Experience League para obter ajuda.
Começar a usar as APIs do Adobe CJA pode parecer assustador no início, mas com um pouco de prática, você estará automatizando fluxos de trabalho e descobrindo insights em pouco tempo. Então, dê o primeiro passo: faça logon, pegue suas credenciais e teste uma chamada de API simples. Sua aventura com a API está esperando por você.