Para registrar indicações via API, é necessário que antes o indicador já esteja cadastrado na beeviral.
Para registrar um indicador, primeiramente você deve saber qual é o tipo da campanha: Clientes ou Influenciadores. Essa informação fica disponível na aba "Campanha" da sua campanha.
Uma vez identificado o tipo da sua campanha, você pode chamar o método específico para cadastrar o novo indicador:
Atenção:
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"
Registrando um novo cliente via API:
- Utitilize o método "Customer/Insert"
Clique aqui para fazer um teste e ver todos os paramentos necessários: https://account.beeviral.app/api/swagger/ui/index#!/Customer/InsertACustomer
Parâmetros da API:
- campaign: Token da campanha disponível na aba "Integrações" da sua campanha
- email: E-mail do cliente
- name: Nome do cliente
- company: Empresa a qual seu cliente trabalha (opcional)
- phone: O número de telefone do seu cliente
- ip: O IP de acesso do seu cliente (opcional)
- sendreferralrequest: Se gostaria de enviar um pedido de indicação ou NPS nesse momento de cadastro. As opções não: "N" (não faz nenhuma ação), "Y" (Envia pedido de indicação) ou "NPS" (Envia pesquisa NPS)
- content: Para enviar informações adicionais no formato JSON EX: {"CPF": "12714565236","PEDIDO":"12356978"}
Caso quera passar informações para os campos adicionais incluidos basta passar o JSON sendo o nome do campo o código do campo criado exemplo. Se crio o campo CPF no menu de Gerenciar Campos e o código do campo gerado é 1010 e o código gerado do campo telefone é 2020 , então basta passar assm no parametro:
EX: {"1010": "12714565236","2020": "5521978653225"} , dessa forma estes dados serão cadastrados nos respectivos campos criados.
Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo:
https://account.beeviral.app/api/v1/Customer/Insert?campaign=xxxxxxxxxxxxxxxx&email=email_cliente@xxx.com&name=Nome_do_cliente&phone=5521999999999&sendreferralrequest=N
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.
Registrando um novo influenciador via API:
- Utitilize o método "Influencer/Insert"
Clique aqui para fazer um teste e ver todos os paramentos necessários: https://account.beeviral.app/api/swagger/ui/index#!/Influencer/InsertAInfluencer
Parâmetros da API:
- campaign: Token da campanha disponível na aba "Integrações" da sua campanha
- email: E-mail do influenciador
- name: Nome do influenciador
- company: Empresa a qual seu influenciador trabalha (opcional)
- phone: O número de telefone do seu influenciador
- ip: O IP de acesso do seu influenciador (opcional)
- sendreferralrequest: Se gostaria de enviar um pedido de indicação nesse momento de cadastro. As opções não: "N" (não faz nenhuma ação), "Y" (Envia pedido de indicação)
- content: Para enviar informações adicionais no formato JSON EX: {"CPF": "12714565236","PEDIDO":"12356978"}
Caso quera passar informações para os campos adicionais incluidos basta passar o JSON sendo o nome do campo o código do campo criado exemplo. Se crio o campo CPF no menu de Gerenciar Campos e o código do campo gerado é 1010 e o código gerado do campo telefone é 2020 , então basta passar assm no parametro:
EX: {"1010": "12714565236","2020": "5521978653225"} , dessa forma estes dados serão cadastrados nos respectivos campos criados.
Todos esses dados devem ser passados via parâmetro na chamada da URL. Exemplo:
https://account.beeviral.app/api/v1/Influencer/Insert?campaign=xxxxxxxxxxx&email=email_influenciador@xxxx.com&name=nome_do_influenciador&sendreferralrequest=N
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.