O método Recommendation/Post permite enviar uma indicação para ser registrada na beeviral
1) Autenticação:
Para realizar suas chamadas à API da beeviral, é necessário antes identificar e autenticar a sua empresa. Para isso, informe o API Token no Header das suas chamadas. Assim: x-token-beeviral=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Importante: O token sempre deve ser enviado via Header
Substitua XXXXXXXXXXXXXXXXXXXXXX pelo API Token da sua empresa. Essa informação está disponível em "Configurações / Integrações", conforme a imagem abaixo:
2) Parâmetros:
Parâmetros da URL:
- Este médodo não pussui parametros
3) Body:
O método deve ser utilizado com o Body. Exemplo:
{
"CAMPAIGN_TOKEN": "string", // Token da campanha (pode ser obtido na aba integrações da campanha "Integrações > Integrações via API> Campaign Token"(dentro da campanha))
"RECOMMENDATION": {
"NAME": "string", // Nome da pessoa indicada (REQUIRED)
"EMAIL": "string", //Email da pessoa indicada (REQUIRED)
"PHONE": "string", //Telefone da pessoa indicada
"EXTERNAL_ID": "string", //Identificador externo do pedido
"STATUS": "string", //Status da pessoa indicada (Convertido, Perdido)
"VALUE": "string", //Valor do pedido
"MESSAGE": "string", //
"ISSAVEPARTICIPANT": "string", //
"ASSOCIATE_PARTICIPANT": {//Participant associado (REQUIRED)
"ID": "string", //ID do participant associado
"EMAIL": "string", //Email do participant associado (REQUIRED)
"EXTERNAL_ID": "string", //ID externo do participant associado
"BV_ID": "string"
},
"ADDITIONAL_FIELDS": [ //Campos adicionais
{
"FIELD": "string",
"VALUE": "string"
}
],
"ADDITIONAL_INFO": [ //Informações adicionais
{
"FIELD": "string",
"VALUE": "string"
}
]
}
}
4) Retorno:
Ao submeter os dados à API e retornar o status de HTTP 200, significa que a indicação foi registrada corretamente na beeviral.
O retorno do médoto será a informação que o registro entrou na fila de processamento com sucesso.
{
"ID": "string",
"MESSAGE": "string"
}
5) Testes:
Para realizar uma chamada teste ao método acesse:
URL: https://account.beeviral.app/api/swagger/ui/index
Versão: V2
Método: Recommendation/Post