Introdução às APIs

Saiba como se comunicar com nossas soluções e construir suas aplicações

Procurando pela collection?

Aqui está

Run in Postman

Atualizado em: 19/05/2026

---

Módulos e endpoints

Nós temos uma série de endpoints com determinados objetivos. Confira o resumo abaixo:

PDV v1

Nosso primeiro módulo para geração e resgate de bônus (giftback). Conta com 9 endpoints que realizam ações desde envio de PIN ao consumidor até estorno de um bônus utilizado.

PDV v2

Exploramos os pontos de melhorias da v1 e o tornamos mais robusto, também focado em geração e resgate de bônus. Este, porém, com 15 endpoints. Sendo as maiores diferenças sob a v1:

• Módulo de produtos: Permite registro e gestão de produtos para geração de campanhas personalizadas;
• Geração automática de registro de venda: Se houve um bônus gerado, tentamos, proativamente, registrar a venda para não defasagem de relatórios da marca.

E-commerce v1 (bônus cuponado)

Nossa primeira versão para giftback nos canais digitais. Este, com um fluxo mais simplificado, conta com 4 endpoints onde a dinâmica ocorre por geração de saldo bônus e resgate deste saldo em um cupom para posterior utilização.

E-commerce v2 (bônus)

Repetimos a prática de melhoria, este, por sua vez, com uma mudança estrutural completa: ao invés da jornada de um geração de um cupom para resgate, o saldo disponível será utilizado para resgate. Equivalente ao fluxo do PDV. Conta com 10 endpoints.

Kafka

Módulo responsável por receber registro assíncronos de vendas. Com 3 rotas.