Fontes de dados e API

Como ligar uma fonte de dados à tua própria API

Última atualização

Com uma fonte de dados de API ligada, o Sendtric acede à tua API para obter os dados de um assinante quando o e-mail dele é aberto. Nada é copiado para o Sendtric, por isso as imagens mostram o que a tua API devolver naquele momento, como o estado de uma encomenda em tempo real ou o saldo da conta de hoje.

Se preferires enviar os dados para o Sendtric com antecedência, vê como enviar registos com a API do Sendtric.

O que a tua API precisa

  • Um URL HTTPS que seja acessível a partir da Internet pública.
  • Uma forma de pedir um registo pelo seu identificador, no caminho ou num parâmetro de consulta. Por exemplo https://api.example.com/customers/12345.
  • A resposta JSON com os campos do registo, como por exemplo {"first_name": "Sarah", "points": 1250}.
  • Uma resposta rápida: o Sendtric espera até 5 segundos e a resposta tem de ter menos de 1 MB.

Configura isso

  1. Na barra lateral esquerda, clica em Fontes de dadose, em seguida, Nova fonte de dados.
  2. Em API, escolhe API e clica em Continuar.
  3. Escolhe Recuperar dados de uma API e clica em Continuar.
  4. Preenche Nome da fonte de dados, Campo de identificador único (por exemplo customer_id) e, se quiseres, Descrição.
  5. Escolhe o Método: GET ou POST.
  6. Introduz a URL da tua API e coloca {{uid}} o identificador no lugar certo, por exemplo https://api.example.com/customers/{{uid}}. O Sendtric substitui {{uid}} pelo identificador de cada assinante.
  7. Adiciona quaisquer cabeçalhos que a tua API precisar, como Authorization com o teu token da API. Clica em + Adicionar para cada um.
  8. Adiciona quaisquer parâmetros de consulta. Se a tua API aceitar o identificador como parâmetro, coloca-o {{uid}} o valor dele em vez da URL, por exemplo id = {{uid}}.
  9. Introduz um identificador válido em Valor do identificador único de teste e clica em Testar API.
  10. Verifica a resposta e, em seguida, clica em Guardar fonte de dados.
A ação «Recuperar dados de uma API Definições» com um URL que contenha {{uid}}, um cabeçalho de autorização, um valor de teste e uma resposta de teste bem-sucedida

Guardar fonte de dados permanece desativado até que o teste seja bem-sucedido e a resposta contenha pelo menos um campo. Se alterares o URL, o método, os cabeçalhos ou os parâmetros, faz o teste novamente.

Usa um endpoint de teste ou um token de API dedicado e só de leitura. O Sendtric mantém os valores dos cabeçalhos em segredo depois de os guardar, por isso vais ter de voltar a introduzir um para o alterares.

Como funcionam as pesquisas

  • Cada pesquisa envia um pedido à tua API para um assinante.
  • Os identificadores são enviados exatamente como o merge tag os preenche, por isso as maiúsculas e minúsculas são importantes se a tua API tiver em conta isso.
  • O Sendtric guarda uma imagem gerada para o tempo de cache que definiste no editor de imagens (2 a 60 minutos), para que as aberturas repetidas não tenham de recorrer à tua API de cada vez.
  • Se a tua API for lenta, devolver um erro ou não tiver nenhum registo para o identificador, o valor é considerado vazio. Numa imagem personalizada, essa camada fica oculta, por isso cria a imagem de forma a que continue a ficar bem sem ela.

Alterar a ligação

Em Fontes de dados, clica na fonte de dados para abrir o seu definições. Podes alterar o URL, o método, os cabeçalhos e os parâmetros e, em seguida, executar Testar API novamente antes de guardares.

Próximo passo

Este artigo foi útil?

Clica na imagem para ampliar. Arrasta ou desliza para ver o resto.