O método Reward/Get permite consultar uma recompensa registrada para um participante 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 recompensa na beeviral

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

    id_participant (string, optional), //Chave única do participant na beeviral 

    dtstart(string, optional), //data inicio recompensa format YYYY-MM-DDTHH:MM:SS

    dtend(string, optional), //data fim da recompensa format YYYY-MM-DDTHH:MM:SS 

    status(string, optional), // Status  da recompensa: (Recompensado|NaoRecompensado|Processando|Liberado|NaoLiberado)

    }


  • 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 Recompensa


[

    {

        "Result": [

            {

                "ID": "string",

                "PEOPLE": "string",

                "CAMPAIGN": "string",

                "REWARD_AVAILABLE": "string",

                "OCCURRENCE": 0,

                "CREATION": "2024-10-29T02:24:04.921Z",

                "MODIFICATION": "2024-10-29T02:24:04.921Z",

                "STATUS": "string",

                "NAME_CAMPAIGN": "string",

                "NAME_INDICATOR": "string",

                "CAMPAIGN_REWARD": "string",

                "CAMPAIGN_REWARD_NAME": "string",

                "ISACTIVE": "string",

                "ISREWARD_PAID": "string",

                "VALUE": 0,

                "KEYS": "string",

                "URL_REWARD": "string",

                "CONTENT": "string",

                "MORE_INFO": "string",

                "EMAILS_INDICATOR": "string",

                "TELEPHONES_INDICATOR": "string",

                "MOREFIELDS": "string",

                "COUPON": "string",

                "TYPE": "string",

                "SUBTYPE": "string",

                "TYPE_VALUE": "string",

                "STATUS_RECOMMENDATION": "string",

                "TYPE_BENEFICIARY": "string",

                "REWARD_AVAILABLE_ITEMS": [{

                        "ITEM_AVAILABLE": "string",

                        "REWARD_ITEM": "string"

                    }

                ]

            }

        ],

        "Paging": {

            "TOTAL": 0,

            "PAGE": 0,

            "LIMIT": 0,

            "RECORDS": 0

        },

        "Sort": {

            "SORT": "string"

        }

    }

]


ResultIndicador
ID:
Chave única da recompensa na beeviral
PEOPLE:
Código do indicador
CAMPAIGN: Código da Campanha
REWARD_AVAILABLE:
Código do item da recompensa
OCCURENCE:
Indice do item da recompensa quando for Meta ou Rank
CREATION:
Data da Criação
MODIFICATION:Data da Alteração
NOME_CAMPAIGN:
Nome da Campanha que originou a recompensa
CAMPAIGN_REWARD_NOME:

Descrição da Recompensa
NOME_INDICATOR:
Nome do Indicador
CAMPAIGN_REWARD:
Código da Campanha para a Recompensa  
ISACTIVE:
Recompensa ativa Y ou N
ISREWARD_PAID:
Recompensa Paga Y ou N
VALUE:Valor da Recompensa
URL_REWARD:Link da Recompensa, quando o tipo for Digital
CONTENT:
Dados adicionais da recompensa
MORE_INFO: DAdos adicionais do indicador
EMAILS_INDICATOR: Emails do Indicador
TELEPHONES_INDICATOR:Telefones do Indicador 
MOREFIELDS:
Campos adicionais do Indicador
COUPON:
Código do coupon, quando a recompensa é do tipo giftcard ou código da transação quando for do tipo crédito
TYPE:
Tipo da recompensa
SUBTYPE:
Subtipo da recompensa
TYPE_VALUE:
Tipo de valor da recompensa ( Valor fixo ou Percentual)
STATUS_RECOMMENDATION:

Status da indicação que originou a recompensa
TYPE_BENEFICIARY:
Tipo de beneficiário da Recompensa (INDICADOR, INDICADO OU COLABORADOR)
REWARD_AVAILABLE_ITEMSITEM_AVAILABLE: Código do item da recompensa
REWARD_ITEM: Descrção do item da recompensa
PAGING: TOTAL: total de páginas
PAGE: página atual
LIMIT: limite de recompensas nessa chamada
RECORDS: quantas recompensas foram chamadas
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: Reward/Get