Pular para o conteúdo
Docs

Integrações e API

API: autenticação e pedidos

Referência inicial para enviar pedidos e estornos e consultar cupons.

Nesta página

Autenticação

Dono e gestores criam chaves em Configurações da marca → API. Use a chave apenas no servidor, no cabeçalho Authorization: Bearer. A base dos endpoints é https://brand.bekrew.com.

Os exemplos usam uma chave fictícia. Troque os dados antes de executar e nunca envie uma chave secreta no frontend.

Enviar um pedido

POST /api/v1/pedidos. Informe id e valor_bruto. Os valores são em reais, não em centavos. Se valor_liquido não for informado, a API calcula valor_bruto menos desconto, com piso zero.

  • id: identificador externo estável do pedido.
  • momento: data e hora ISO; se omitido, usa o horário de recebimento.
  • moeda: brl por padrão.
  • desconto, frete e valor_liquido: valores numéricos.
  • cupom, clique e assinatura: identificadores usados na atribuição.
  • recorrente: indica recorrência.
  • itens: lista de produto, sku, quantidade e valor, quando disponíveis.
Terminal · exemplo
curl -X POST https://brand.bekrew.com/api/v1/pedidos \
  -H "Authorization: Bearer SUA_CHAVE_KREW" \
  -H "Content-Type: application/json" \
  -d '{"id":"EXEMPLO-1001","valor_bruto":100,"desconto":0,"valor_liquido":100,"cupom":"CREATOR10"}'

Resposta e repetição

Um novo pedido responde com HTTP 201. Reenvio do mesmo identificador na mesma conexão retorna HTTP 200, sem criar outro pedido. A resposta contém pedido, novo e atribuicao. Falhas de autenticação retornam 401; dados inválidos retornam 422. Um estorno de pedido não encontrado retorna 404.

Registrar um estorno

POST /api/v1/pedidos/{id}/estorno. O id é o identificador externo enviado no pedido. Sem valor, solicita estorno total. Informe valor para um estorno parcial.

Terminal · exemplo
curl -X POST https://brand.bekrew.com/api/v1/pedidos/EXEMPLO-1001/estorno \
  -H "Authorization: Bearer SUA_CHAVE_KREW" \
  -H "Content-Type: application/json" \
  -d '{"valor":50}'

Consultar cupons

GET /api/v1/cupons retorna os cupons e suas regras para integração com sua plataforma. A chave limita o acesso à marca associada.

Terminal · exemplo
curl https://brand.bekrew.com/api/v1/cupons \
  -H "Authorization: Bearer SUA_CHAVE_KREW"