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 ecossistema 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) Buscando uma indicação na beeviral via API:
- Utilize o método "RecommendationFind_by_email"
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:
- emailrecommendation: email 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-)
Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo:
https://account.beeviral.app/api/v1/Recommendation/Find_by_email?emailrecommendation=xxxxxx
PS:
Lembrando que o token deve ser passado via Header.
E ao submeter os dados à API e retornar o status de HTTP 200, significa que a indicação foi registrada corretamente na beeviral.
Sucesso!