Bônus

Rotas utilizadas

#	Referência	HTTP Método
1	/bonus/available	`POST`
2	/user/verify	`POST`
2	/bonus/available	`POST`
2	/bonus/campaigns	`POST`
2	/bonus/submit	`POST`

Cenário 1 — Consulta de saldo de bônus (usuário existente)

Quando o PDV precisa verificar o saldo de bônus de um consumidor que já está cadastrado na base da CRMBonus:

1

📘
bonus_balance ≠ bonus_available

bonus_balance é o saldo total que este consumidor tem em sua conta para esta loja

bonus_available é quanto, deste saldo, pode ser consumido de acordo com as características da venda informadas no objeto items.

Confira a referência da rota

Como identificar se o usuário já existe na base?

O CPF, quando cadastrado, é o segundo identificador do consumidor (sendo o telefone, o primeiro). Ao consultá-lo, a API retorna um hash de identificação no seguinte formato:

{
  "data": {
    "user_id": "0zXtCRB91brXqq92ud5KqQ==" <---
  }
}

Se o sistema do PDV armazena esse hash localmente, ele pode utilizá-lo para não mais precisar acionar a /user/verify para confirmar o vínculo do consumidor.

Cenário 2 — Resgatar e/ou gerar bônus

📘
A rota /bonus/submit gera e resgata bônus?
Sim. A rota /bonus/submit é responsável tanto pela geração quanto pelo resgate de bônus. O comportamento de cada operação depende das configurações e campanhas ativas.

Resgate: O resgate pode ser bloqueado por configurações específicas da campanha. Além disso, se a flag bonus_accumulate_flag: true for retornada pela rota /bonus/available, o consumidor tem a opção de não resgatar o saldo naquela compra, acumulando-o para uso futuro.

Geração: Na maioria das chamadas à /bonus/submit, bônus são gerados. Entretanto, há cenários em que a geração não ocorre, a depender das regras da campanha vigente.

2