DOCUMENTAÇÃO DA API

Integre cupons e promoções ao backend da sua aplicação.

A API REST recebe o contexto comercial da compra, avalia as regras configuradas no painel e devolve resultados estruturados para o seu sistema.

Indicado para: Desenvolvedores e arquitetos responsáveis pela integração server-to-server com a plataforma.

PARA DESENVOLVEDORES

Implemente com o contrato completo da API.

Consulte endpoints, autenticação, payloads, respostas e erros na referência OpenAPI interativa.

VALOR PARA A OPERAÇÃO

Endpoints previsíveis para consultar, calcular e efetivar operações.

Credenciais por projeto, ambiente, expiração e escopo de permissão.

Operações transacionais protegidas contra repetições acidentais.

Contrato navegável disponível no ambiente da API para apoiar a implementação.

COMO FUNCIONA

01
Crie um projeto
Separe a integração e gere uma credencial no ambiente desejado.
02
Calcule o desconto
Envie consumidor e carrinho para avaliar o código ou consultar ofertas elegíveis.
03
Finalize o fluxo
Confirme o resgate, associe pagamento e use estorno quando necessário.

PERGUNTAS FREQUENTES

Onde a API key deve ficar?

Somente no backend da sua aplicação ou em um serviço seguro. Nunca exponha a credencial no navegador ou aplicativo cliente.

Quais dados o cálculo recebe?

Código ou consulta de elegibilidade, consumidor, carrinho, quantidades, preços e os atributos necessários às regras configuradas.

Existe separação entre consulta e efetivação?

Sim. As permissões das credenciais podem separar leitura, efetivação e pagamento.

VALIDAÇÃO SEM COMPROMISSO