A integração para o PDV foi toda pensada para acontecer no final da venda. A primeira chamada deve ocorrer na passagem para a tela de pagamento.
Esta API segue um fluxo linear, o que significa que uma chamada deve ocorrer obrigatoriamente em seguida da outra, pois há dependências de dados entre elas.
Postman Collection
Disponibilizamos uma collection do Postman:
Atualizado em: 20/05/2026
Ambientes
Fluxo Linear Giftback
| Ambiente | URL |
|---|---|
| Sandbox | https://giftback-sandbox.crmbonus.com/pages |
| Produção | https://www.crmbonus.com/pages |
Envio de Dados Assíncronos (Kafka)
| Ambiente | URL |
|---|---|
| Homologação | https://kafka-rest-homol.crmbonus.com |
| Produção | https://kafka-rest.crmbonus.com |
Fluxo de Chamadas
Os seis endpoints da imagem acima são os responsáveis por todo o processo de bonificação. Na mesma imagem já é possível verificar também a ordem na qual devem ocorrer as chamadas.
Fluxo Operacional
Através do fluxograma operacional e da documentação, é possível visualizar com mais clareza as diferentes variáveis desta integração e o motivo de sua linearidade.
Respostas de Erro Comuns:Os retornos da API sempre virão com o status 200 . Os erros devem ser mapeados através do response body.
Há erros individuas de cada endpoint, estes serão definidos em sua respectiva aba na documentação. Entretanto, estaremos disponibilizado abaixo os principais erros que poderão ser retornados na API.
Acesso não autorizado: Quando o header "authorization" está é inválido ou não foi utilizado;
Header incompleto: Quando há informações faltando, normalmente seguido desta especificação;
Loja não encontrada: Quando não é encontrado o header "codEmpresa";
Sistema de bonificação inativo: Normalmente sinaliza que a plataforma foi desabilitada (entrar em contato com a equipe CRM&Bônus);
Celular inválido: Indica que o número de celular informado não é válido;
Celular bloqueado: Indica que o cliente está em uma "Deny List" da marca;
CPF Bloqueado: Indica que o CPF do cliente está em uma "Deny List" da marca;
Lojas em Conflito: Quando o header codEmpresa não pertence ao loja_id informado no body;
Cliente em Conflito: Quando o celular informado no header não pertence ao customer_id informado no body.