Dados necessários para API
Para começar a usar a API, vocé precisará das seguintes informações:
Token da API
URL para webhook
ID do plano que será usado
ID do evento (caso seja um evento personalizado)
Você tem acesso ao seu token da API na tela de Configurações Gerais – API Voxuy – Token API.
Sua URL para webhook (onde você enviará seus dados), está disponível em Integrações – API Voxuy – URL para webhook.
Como ensinado na página da API Voxuy, você pode usar um produto que já está integrado com sua plataforma ou adicionar um novo. Em qualquer caso, para enviar um webhook para a Voxuy, você precisará de um plano configurado para um produto. Para isso, basta ir em Produtos – Escolhe o produto desejado – Escolha o plano desejado – copie o ID do plano.
Caso você queira enviar um evento personalizado (como já mostrado na página API Voxuy), você precisará do ID do evento personalizado que você criou.
Se este é o seu caso, vá para Funil de Conversão – Selecione o produto desejado – Clique na aba Personalizado – Selecione o evento desejado – Copie o ID do evento.
Caso você queira usar um evento Padrão (como Boleto Gerado, Cartão Aprovado, etc), você pode pular este passo, pois o evento será reconhecido de acordo com os dados passados no campo do webhook.
Agora que você tem todos os dados necessários, basta seguir para a Documentação da API para enviar a requisição.
Token da API
URL para webhook
ID do plano que será usado
ID do evento (caso seja um evento personalizado)
Token da API
Você tem acesso ao seu token da API na tela de Configurações Gerais – API Voxuy – Token API.
URL para webhook
Sua URL para webhook (onde você enviará seus dados), está disponível em Integrações – API Voxuy – URL para webhook.
ID do plano
Como ensinado na página da API Voxuy, você pode usar um produto que já está integrado com sua plataforma ou adicionar um novo. Em qualquer caso, para enviar um webhook para a Voxuy, você precisará de um plano configurado para um produto. Para isso, basta ir em Produtos – Escolhe o produto desejado – Escolha o plano desejado – copie o ID do plano.
ID do evento
Caso você queira enviar um evento personalizado (como já mostrado na página API Voxuy), você precisará do ID do evento personalizado que você criou.
Se este é o seu caso, vá para Funil de Conversão – Selecione o produto desejado – Clique na aba Personalizado – Selecione o evento desejado – Copie o ID do evento.
Caso você queira usar um evento Padrão (como Boleto Gerado, Cartão Aprovado, etc), você pode pular este passo, pois o evento será reconhecido de acordo com os dados passados no campo do webhook.
Próximo Passo
Agora que você tem todos os dados necessários, basta seguir para a Documentação da API para enviar a requisição.
Actualizado em: 14/07/2022