Para empresas que possuem um processo de venda "offline/consultivo" ou por algum outro motivo não for possível realizar integrações via script, podem realizar integrações com a beeviral através das nossas APIs.


A documentação completa de todos os métodos disponíveis na API da beeviral podem ser encontradas aqui: https://account.beeviral.app/api/swagger/ui/index


Observação: Lembrando que a beeviral faz parte do ecosistemas de soluções integradas ao Zapier, o que permite integrar facilmente a beeviral há mais de 4.000 outras aplicações sem precisar nenhuma programação. Clique aqui para saber mais sobre as integrações da beeviral através do zapier: https://zapier.com/apps/indexia/integrations



1) Informando o API Token no Header das suas chamadas à API:


Para realizar suas chamadas à API da beeviral, é necessário antes identificar a sua empresa. Para isso, informe o API Token no Header das suas chamadas. Assim: token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX


Substitua XXXXXXXXXXXXXXXXXXXXXX pelo API Token da sua empresa. Essa informação está disponível em "Configurações / Integrações"




2) Registrando uma Indicação na beeviral via API:


  • Utitilize o método "Recommendation/Insert"


Clique aqui para fazer um teste e ver todos os paramentos necessários: https://account.beeviral.app/api/swagger/ui/index#!/Recommendation/InsertARecommendation


Parâmetros da API:


  • campaign: Token da campanha disponível na aba "Integrações" da sua campanha
  • email: E-mail do usuário indicador. Esse e-mail é enviado para o seu site via parâmetro na URL sempre que ocorre o clique em um link de indicação. Atenção: Antes de registrar a indicação, é obrigatório que já exista o indicador antes. Clique aqui e veja como registrar um novo indicar via api caso necessário)
  • emailrecommendation: E-mail da pessoa indicada
  • name: Nome da pessoa indicada
  • channel: Mantenha fixo como "Manual"
  • status: O status dessa indicação. Por exemplo: Indicado, Convertido, etc... Default é "Indicado"
  • value: Em caso de conversão, você pode adicionar o valor da conversão. (Opcional)
  • message: Alguma observação que queira registrar sobre essa indicação
  • phone: O número de telefone da pessoa indicada



Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo: 

https://account.beeviral.app/api/v1/Recommendation/Insert?campaign=XXXXXXXXXXXXXXXXXXXX&email=indicador@indicador.com.br&emailrecommendation=email@email_da_pessoa_indicada.com.br&name=Nome_da_pessoa_indicada&channel=Manual&status=Indicado&value=0.00&phone=5521999999999


PS: Lembrando que o token deve ser passado via Header


Ao submeter os dados à API e retornar o status de HTTP 200, significa que a indicação foi registrada corretamente na beeviral.