Registrando Uma Conversão Via API (Volta)
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: Documentação API
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 conversão na beeviral via API:
- PUT: Utitilize o método "Recommendation/Update_by_id" (Via PUT)
Clique aqui para fazer um teste e ver todos os paramentos necessários: https://account.beeviral.app/api/swagger/ui/index#!/Recommendation/UpdateARecommendationid
Parâmetros da API:
- idrecommendation: id da indicação informado via webhook (saiba mais aqui: https://beeviral.freshdesk.com/support/solutions/articles/65000180829-registrando-as-indicac%C3%B5es-no-seu-crm-ou-e-mail-marketing-ida-) (obrigatório)
- status: Informar "Convertido" (obrigatório)
- name: Nome da pessoa indicada (obrigatório)
- value: Valor da conversão (opcional)
- phone: Telefone da pessoa indicada (opcional)
Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo:
https://account.beeviral.app/api/v1/Recommendation/Update_by_id?idrecommendation=xxxxxx&name=nome_da_pessoa_indicada&status=Convertido&value=250.99
- Utitilize o método "Recommendation/Update_by_email"
Clique aqui para fazer um teste e ver todos os paramentos necessários: https://account.beeviral.app/api/swagger/ui/index#!/Recommendation/UpdateARecommendationemail
Parâmetros da API:
- emailrecommendation: email da pessoa indicada
- status: Informar "Convertido"
- value: Valor da conversão (opcional)
- name: Nome da pessoa indicada (opcional caso tenha mudado desde a indicação )
- phone: Telefone da pessoa indicada (opcional caso tenha mudado desde a indicação)
Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo:
https://account.beeviral.app/api/v1/Recommendation/Update_by_email?emailrecommendation=email_da_pessoa_inicada&status=Converido&valor=250.99&phone=telefone_da_pessoa_indicada
- PUT: Utitilize o método "Recommendation/Update_status" (Via PUT)
Clique aqui para fazer um teste e ver todos os paramentos necessários: https://account.beeviral.app/api/swagger/ui/index#!/Recommendation/UpdateARecommendationStatus
Parâmetros da API:
- idrecommendation: id da indicação informado via webhook (saiba mais aqui: https://beeviral.freshdesk.com/support/solutions/articles/65000180829-registrando-as-indicac%C3%B5es-no-seu-crm-ou-e-mail-marketing-ida-) (obrigatório)
- status: Informar "Convertido" (obrigatório)
- value: Valor da conversão (opcional)
Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo:
https://account.beeviral.app/api/v1/Recommendation/Update_status?idrecommendation=xxxxxx&status=Convertido&value=250.99
PS: O token deve ser sempre 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.