Como integrar uma plataforma não listada na Utmize?

Antes de desenvolver ou integrar uma plataforma customizada à UTMIZE, crie uma credencial no seu Dashboard. Caso não possua uma, aprenda como gerar acessando Como gerar uma credencial de API Utmize.

Já tem suas credenciais? Então vamos prosseguir!

Compreendendo os dados necessários para API UTMIZE

Ao integrar com a API UTMIZE, é crucial estruturar seus dados corretamente para garantir o envio bem-sucedido dos dados. Abaixo está um guia detalhado sobre o formato de dados esperado e outros requisitos.

Estrutura de dados necessária

A API UTMIZE espera dados em formato JSON com chaves específicas. Aqui está a estrutura exata e os dados de amostra que você deve enviar:

{  
   "product_name": "Laptop",
   "external_id": "eXternId",
   "plataform": "Website",
   "utm_source": "google",
   "utm_medium": "cpc",
   "utm_campaign": "holidaysale",
   "utm_term": "discount",
   "utm_content": "bannerad",
   "payment_status": "paid",
   "payment_method": "credit_card",
   "value": 15075
}

Cada chave na estrutura JSON representa um aspecto diferente dos dados que você está rastreando:

• plataform: A plataforma onde ocorreu a interação (por exemplo, site, MobileApp).

• product_name: Nome do produto.

• external_id: Id externo para controle de status.

• utm_source: a origem do tráfego (por exemplo, google, facebook).

• utm_medium: o meio pelo qual o tráfego veio (por exemplo, CPC, e-mail).

• utm_campaign: o nome específico da campanha associado aos dados (por exemplo, holidaysale).

• utm_term: os termos de palavra-chave associados à campanha.

• utm_content: o tipo de conteúdo com o qual houve interação (por exemplo, bannerad, textlink).

• payment_status: o status do pagamento (por exemplo, pago, pendente).

• payment_method: O método de pagamento utilizado (por exemplo, credit_card, paypal).

• value: O valor monetário associado à interação em centavos.

Requisitos de cabeçalho

Ao enviar dados para a API UTMIZE, inclua um token de autorização no cabeçalho. O token deve ser formatado como um token de portador:

Authorization: Bearer SEU_TOKEN

Response Codes

A API responderá com diferentes códigos de status com base no sucesso ou na falha do envio de dados:

• 200 OK: A solicitação foi bem-sucedida e os dados foram processados ​​corretamente.

• 401 Não autorizado: a solicitação falhou devido a um token de autorização inválido ou ausente.

Tratamento de dados ausentes

Se algum campo de dados estiver faltando, a API considerará o valor como nulo. É essencial fornecer todos os campos obrigatórios para garantir o processamento preciso dos dados.

Ajuda

Se você encontrar algum problema ou tiver dúvidas sobre a integração da API, consulte nossa equipe de suporte para obter assistência.

Seguindo as diretrizes acima, você pode garantir uma integração tranquila com a API UTMIZE e rastreamento de dados preciso para suas campanhas.