Comece aqui
Faça sua primeira integração
Crie um projeto, configure uma API key e execute a primeira cotação de desconto com a API REST do Cupom.
Nesta página
Este guia percorre o caminho mínimo entre uma conta nova e uma cotação de desconto. Faça os primeiros testes em um ambiente não produtivo e use dados fictícios.
Antes de começar
Você precisa de uma organização, um projeto no ambiente desejado, um cupom ativo e uma API key com permissão de leitura. A chave é exibida uma única vez ao ser criada.
1. Configure a credencial
Guarde a chave em um cofre de segredos ou variável de ambiente do seu backend:
export CUPOM_API_KEY="cpm_..."
HML e PRD usam a mesma origem:
https://api.cupom.center
2. Valide a integração
Use GET /v1/coupon/integration para conferir, sem faturamento, a organização, o ambiente, o projeto, a moeda e as permissões associadas à credencial.
curl 'https://api.cupom.center/v1/coupon/integration' \
--header "Authorization: Bearer $CUPOM_API_KEY" \
--header 'Accept: application/json'
3. Calcule o desconto
Envie o código e o contexto do carrinho para POST /v1/coupon/discount/single:
curl --request POST 'https://api.cupom.center/v1/coupon/discount/single' \
--header "Authorization: Bearer $CUPOM_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"cart_id": "cart-001",
"coupon_code": "BEMVINDO15",
"context": {
"user": { "id": "user-001" },
"cart": [{ "id": "CAMISETA-01", "quantity": 2, "unitary_price": 100 }],
"shipping": { "amount": 25 }
}
}'
A resposta inclui quote_id, validade da reserva, itens calculados e totais. Guarde o identificador se o fluxo avançar para o resgate.
Próximos passos
Entenda autenticação e permissões, aprofunde o cálculo de desconto e só depois implemente a conclusão da operação.