O método Participant/Get permite consultar um participante registrado na campanha com base nos filtros fornecidos.
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:
- filter: Permite informar os filtros que serão aplicados na consulta. Os filtros disponíveis são:
filter {
id (string, optional), //Chave única da indicação na beeviral
campaign_token (string, required), //Token da campanha (pode ser obtido na aba integrações da campanha)
name (string, optional), //Nome do indicador
email (string, optional), //Email do indicador
phone (string, optional), //Telefone do indicador
ip (string, optional), // Endereço de IP da pessoa indicada no momento em que a indicação foi capturada
external_id (ClassFromBody, optional), //Identificador externo da pedido (chave externa)
bv_id (string, optional), //Código identificador único do link de compartilhamento)
additional_fields (string, optional) //Campos adicionais da indicação. Exemplo: "additional_fields":"{"codigo":"valor","codigo":"valor"}"
}
- page: Permite informar qual a página que deve ser retornado. Default=0
- limit: Permite informar o máximo de linhas que deve ser retornado. Tamanho máximo por página é de 200 registros. Default=1
- sort: Permite informar a ordem em que os registros serão retornados. Valores possíveis:
- asc: Mais antigos primeiro
- desc: Mais recentes primeiro (Default=desc)
Exemplo via swagger:
Paramêtros:
Resposta:
Exemplo via postman:
Exemplos:
- Retornar a última indicação na campanha jhdskjhFRE457899z09 onde o email da pessoa indicada seja teste@teste.com:
- Retornar a última indicação da campanha jhdskjhFRE457899z09que o cpf da pessoa indicada seja 12345678900:
- https://account.beeviral.app/api/v2/Participant?filter={"campaign_token":"jhdskjhFRE457899z09","additional_fields":"{"cpf": "12345678900"}"}
- Retornar a última indicação onde o cpf da pessoa indicada seja 12345678900 (independente da campanha):
- https://account.beeviral.app/api/v2/Participant ?filter={"additional_fields":{"cpf": "12345678900"}}
- Retornar a indicação mais antiga onde o cpf da pessoa indicada seja 12345678900 (independente da campanha):
3) Body:
O método deve ser utilizado com o Body vazio.
4) Retorno:
Ao submeter os dados à API e retornar o status de HTTP 200, significa que a indicação foi registrada corretamente na beeviral.
A consulta retornará um List de Recommendation
[
{
"Result": [
{
"ID": "string",
"CODE": "string",
"NAME": "string",
"EMAIL": "string",
"PHONE": "string",
"ACTIVE": "string",
"COMPANY_SYSTEM": {
"ID": "string",
"CODE": "string",
"NAME": "string"
},
"CREATION": "2023-05-21T02:44:56.736Z",
"MODIFICATION": "2023-05-21T02:44:56.736Z",
"COMPANY": "string",
"CAMPAIGN": [
{
"ID": "string",
"CODE": "string",
"NAME": "string"
}
],
"SHARE_LINK": "string",
"HOME_LINK": "string",
"EXTERNAL_ID": "string",
"ADDITIONAL_FIELD": [
{
"FIELD": "string",
"VALUE": "string"
}
],
"ADDITIONAL_INFO": [
{
"FIELD": "string",
"VALUE": "string"
}
],
"IP": "string"
}
],
"Paging": {
"TOTAL": 0,
"PAGE": 0,
"LIMIT": 0,
"RECORDS": 0
},
"Sort": {
"SORT": "string"
}
}
]
| Result | Indicador |
|---|---|
| ID: | Chave única da indicação na beeviral |
| CODE: | Código do indicador |
| NAME: | Nome da pessoa indicada |
| EMAIL: | Nome da pessoa indicada |
| PHONE: | Telefone da pessoa indicada |
| ACTIVE: | Se a pessoa indicada está ativa "Y" ou "N" (Sim ou não) |
| COMPANY_SYSTEM: | ID: id da empresa CODE: código da empresa NAME: nome da empresa |
| CREATION: | Data de criação dessa indicação |
| MODIFICATION: | Data de modificação dessa indicação |
| COMPANY: |
| CAMPAIGN: | ID: id da campanha CODE: código da campanha NAME: nome da campanha SHARE_LINK: link de compartilhamento da campanha HOME_LINK: home da campanha |
| EXTERNAL_ID: | ID externo do indicado |
| ADDITIONAL_FIELD: (Campos adicionais) | FIELD: campo VALUE: valor |
| ADDITIONAL_INFO: (Informações adicionais) | FIELD: campo VALUE: valor |
| IP: | Endereço de IP da pessoa indicada no momento em que a indicação foi capturada |
| PAGING: | TOTAL: total de páginas PAGE: página atual LIMIT: limite de indicados nessa chamada RECORDS: quantos indicados foram chamados |
| SORT: | SORT: desc = decrescente asc = crescente |
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: Participant/Get