Este guia aborda as APIs do Adobe Customer Journey Analytics (CJA), detalhando a extração de dados, soluções personalizadas e integração com terceiros. Inclui a configuração de acesso, chaves de API, testes com o Postman, um exemplo passo a passo de chamada de API e dicas para quem está começando.

Você é novo em APIs e quer saber como as APIs do Adobe Customer Journey Analytics (CJA) podem ajudar? Não se preocupe! Neste guia para iniciantes, mostramos o essencial, explicamos os principais termos e ajudamos você a dar os primeiros passos nesse universo das APIs do CJA.

Imagine poder acessar e analisar seus dados do CJA de forma programática, sem esforço manual. É exatamente isso que as APIs do CJA permitem fazer!

• Extraia dados com eficiência: otimize a extração de dados usando chamadas de API.
• Crie soluções personalizadas: projete e implemente fluxos automatizados de relatórios sob medida para as necessidades do seu negócio.
• Conecte-se sem obstáculos: permita o fluxo de dados entre o CJA e aplicativos de terceiros por meio de integrações robustas.

Pense nas APIs como mensageiras: elas levam seus pedidos aos servidores da Adobe e trazem os resultados organizados para você.

Preparando-se para o sucesso

Antes de fazer sua primeira chamada de API, é necessário configurar o acesso e as permissões adequados. Primeiro, verifique se você foi adicionado como desenvolvedor da sua organização. Em seguida, confirme que você tem acesso aos perfis de produto com as permissões necessárias.

Etapa 1: obtenha sua chave de API

1. Acesse o Adobe Developer Console.
2. Crie um novo projeto e adicione a API do Customer Journey Analytics ao seu projeto e selecione os perfis de produto necessários.
3. Clique em Adicionar ao projeto e adicione também a API do Adobe Experience Platform ao projeto
4. Quando a configuraçã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 de cabeçalho essenciais exigidos em todas as solicitações de API:

• Token de acesso – Garante que apenas pessoas autorizadas acessem os dados e pode ser gerado ao clicar no CTA Gerar token de acesso destacado na captura de tela. Esse parâmetro é chamado de autorização na solicitação de API.
• Client ID – Também conhecido como chave de API, esse parâmetro é chamado de x-api-key na solicitação de API.
• Organization ID – Esse parâmetro é chamado de x-gw-ims-org-id na solicitação de API.

Salve essas credenciais — elas são a chave para liberar todo o potencial da API! Instruções detalhadas, passo a passo, estão disponíveis na seção Introdução da API do CJA.

Etapa 2: Testar sua configuração

Uma ótima maneira de testar APIs sem escrever código é usar a poderosa e intuitiva ferramenta Postman. Após abrir o aplicativo, você pode importar facilmente suas credenciais de API e começar a experimentar com solicitações GET simples para verificar se sua conexão e autenticação estão funcionando corretamente. Recomenda-se iniciar seus testes de API com solicitações GET, pois elas são consideradas mais seguras e não destrutivas, já que apenas recuperam dados do servidor sem fazer modificações. Isso difere de outros métodos HTTP, como solicitações POST, PUT ou DELETE, que podem alterar ou remover dados no servidor e, por isso, devem ser testados com mais cautela.

Fazendo sua primeira chamada de API

Vamos fazer algo simples: buscar uma lista das visualizações de dados disponíveis na sua conta CJA.

Exemplo: Lista de visualizações de dados

Endpoint:
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}

Requisiçã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 requisições na documentação do endpoint da API CJA usando o recurso Try It. Aqui está o link para testar a requisição acima.

Basta clicar no CTA Try It e preencher todos os parâmetros obrigatórios, neste caso os parâmetros de cabeçalho que mencionamos, e então clicar em Send.

Você também pode incluir parâmetros adicionais para personalizar sua solicitação. Uma lista dos parâmetros disponíveis está na seção Query Parameters de cada solicitação de API na documentação da API do CJA.

Veja os principais códigos de resposta HTTP que você encontra ao trabalhar com APIs:

• 200: Sucesso — O servidor processou a solicitação com êxito e retornou os dados
• 404: Não encontrado — O servidor não conseguiu localizar o recurso solicitado
• 500: Erro interno do servidor — Um erro ocorreu no lado do servidor

Esses códigos do status mostram exatamente o que aconteceu durante uma solicitação de API, facilitando a identificação de problemas.

Dicas para quem está começando a usar API

1. Verifique seu acesso: Garanta que você tem os níveis corretos de permissões e que está incluído nos perfis de produto adequados. O acesso inadequado é a causa mais comum de falhas em solicitações de API
2. Teste, teste, teste: Use o recurso Experimentar na documentação do endpoint da API ou no Postman para testar solicitações antes de escrever código.
3. Comece aos poucos: Inicie com uma solicitação GET simples e avance para consultas POST.
4. Use a documentação: A documentação da API do CJA da Adobe é sua melhor aliada. Consulte as atualizações regularmente, pois configurações antigas podem deixar de funcionar como esperado após grandes atualizações.
5. Tire dúvidas: Procure a comunidade Experience League Adobe Analytics sempre que precisar de ajuda.

Começar a usar as APIs do Adobe CJA pode parecer desafiador no início, mas com um pouco de prática, você vai automatizar fluxos de trabalho e descobrir insights rapidamente. Então, dê o primeiro passo: faça login, pegue suas credenciais e teste uma chamada de API simples. Sua jornada com API está só começando!