Fluxo de integração da API PDV V2 a nível SKU.
A integração com a API de PDV V2 foi projetada para ocorrer durante o processo de venda. Na versão atual da API, esse bônus pode ser aplicado no nível de SKU, possibilitando a configuração de regras de geração e resgate de bônus para produtos, categorias, fabricantes, entre outros.
Postman Collection
Disponibilizamos uma collection do Postman:
Atualizado em: 20/05/2026
Ambientes
Autenticação Giftback
| Ambiente | URL |
|---|---|
| Sandbox | https://auth-homol.crmbonus.com |
| Produção — Alternativa A | https://apipdv.crmbonus.com |
| Produção — Alternativa B | https://auth-prod.crmbonus.com |
Fluxo Linear Giftback
| Ambiente | URL |
|---|---|
| Sandbox | https://apipdv-homol.crmbonus.com |
| Produção | https://apipdv.crmbonus.com |
Envio de Dados Assíncronos (Kafka)
| Ambiente | URL |
|---|---|
| Homologação | https://kafka-rest-homol.crmbonus.com |
| Produção | https://kafka-rest.crmbonus.com |
Cadastro de Produto
ObservaçãoO módulo de produtos é opcional. Caso não haja necessidade de integrar a nível SKU, os endpoints de cadastro de produtos podem ser desconsiderados.
Antes de utilizar o fluxo principal da aplicação, que envolve a geração e o resgate de bônus, é possível cadastrar os produtos, seja em lote ou individualmente. Esse processo garante que os produtos estejam devidamente registrados na CRMBonus, permitindo que eles sejam utilizados na configuração de regras para geração e resgate de bônus.
Frequência de Envio e Atualização de ProdutosCarga manual em lote
O sistema PDV deve ter a possibilidade de selecionar um ou mais produtos previamente cadastrados na base e enviá-los para a CRMBonus utilizando a rota /product/batch/add.Sincronização manual
Deve ser criado um gatilho de sincronização manual, que ao ser acionado, sincroniza a base de produtos do sistema PDV com a CRMBonus através das rotas /product/batch/add e /product/batch/edit.Sincronização automática
Deve ser possível habilitar a sincronização automática de dados, garantindo que todos os novos produtos adicionados ou atualizados no sistema PDV reflitam automaticamente na CRMBonus, por meio das rotas /product/add e /product/batch/edit.
Fluxo de Chamadas
API opera em um fluxo linear, o que exige que as chamadas sejam realizadas em sequência, devido às dependências de dados entre as etapas.
Envio de Vendas Totais
Para garantir o funcionamento correto da integração e a precisão no cálculo dos indicadores de engajamento da marca, é imprescindível o envio de todas as vendas da marca para os endpoints /sales/total e /total-orders/producer. O endpoint /sales/total processa as vendas de forma síncrona, no momento da compra no PDV, enquanto o /total-orders/producer realiza o processamento de maneira assíncrona. Essa abordagem assegura a captura completa de todas as operações relacionadas à marca, permitindo maior confiabilidade nos dados.
A frequência de envio (30 minutos) pode ser acordada durante a integração.
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.
Status Code
| Code | Response |
|---|---|
| 200 - Success | { "status": true, "message": "Success", "data": {} } |
| 201 - Created | { "status": true, "message": "Success", "data": {} } |
| 400 - Bad Request - Invalid parameter | { "status": false, "message": "Invalid parameters.", "data": [ "Empty user_id", "User not found" ] } |
| 401 - Unauthorized | { "status": false, "message": "Invalid Token", "data": "" } |
| 403 - Forbidden | |
| 404 - Not Found | |
| 502 - Bad Gateway |