O método Recommendation/Get permite consultar uma indicação registrada na beeviral 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 {

    campaign_token (string, required), //Token da campanha (pode ser obtido na aba integrações da campanha)

    id (string, optional), //Chave única da indicação na beeviral
    name (string, optional), //Nome da pessoa indicada

    email (string, optional), //Email da pessoa indicada

    phone (string, optional), //Telefone da pessoa indicada

    ip (string, optional), //Endereço de IP da pessoa indicada no momento em que a indicação foi capturada

    order_id (string, optional), //Identificador externo da pedido (chave externa)
    external_id (ClassFromBody, optional), //Identificador externo da pedido (chave externa)

    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:





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",

        "NAME": "string",

        "EMAIL": "string",

        "PHONE": "string",

        "MESSAGE": "string",

        "ACTIVE": "string",

        "CONVERT": "string",

        "VALUE": 0,

        "CONVERSION": "2023-05-21T02:44:56.815Z",

        "CREATION": "2023-05-21T02:44:56.815Z",

        "MODIFICATION": "2023-05-21T02:44:56.815Z",

        "CHANNEL": "string",

        "STATUS": "string",

        "COMPANY_SYSTEM": {

          "ID": "string",

          "CODE": "string",

          "NAME": "string"

        },

        "PARTICIPANT": {

          "ID": "string",

          "CODE": "string",

          "NAME": "string"

        },

        "CAMPAIGN": {

          "ID": "string",

          "CODE": "string",

          "NAME": "string"

        },

        "ORDER_ID": "string",

        "ADDITIONAL_FIELD": [

          {

            "FIELD": "string",

            "VALUE": "string"

          }

        ],

        "ADDITIONAL_INFO": [

          {

            "FIELD": "string",

            "VALUE": "string"

          }

        ],

        "EXTERNAL_ID": "string",

        "IP": "string"

      }

    ],

    "Paging": {

      "TOTAL": 0,

      "PAGE": 0,

      "LIMIT": 0,

      "RECORDS": 0

    },

    "Sort": {

      "SORT": "string"

    }

  }

]



ResultIndicado
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
MESSAGE:

ACTIVE:
Se a pessoa indicada está ativa "Y" ou "N" (Sim ou não)
CONVERT:Se a indicação foi convertida ou não "Y" ou "N"
VALUE:Valor da compra ou negócio realizado
CONVERSION: 
CREATION:
Data de criação dessa indicação
MODIFICATION:
Data de modificação
CHANNEL:
Canal de indicação
STATUS:Status da indicação
COMPANY_SYSTEM:ID: id da empresa
CODE: código da empresa
NAME: nome da empresa
PARTICIPANT:ID: id do indicador
CODE: código do indicador
NAME: nome do indicador 
CAMPAIGN:
ID: id da campanha
CODE: código da campanha
NAME: nome da campanha
ORDER_ID:ID do pedido
ADDITIONAL_FIELD: (Campos adicionais)
FIELD: campo
VALUE: valor
ADDITIONAL_INFO: (Informações adicionais)FIELD: campo
VALUE: valor

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/Get