Navegar na documentação

Changelog da API

Contrato da API: 1.1.0 (OpenAPI 3.1). A base dos endpoints é a origem atual (/); veja a referência interativa.

Convenções

Versão major no caminho: /api/v1, /sdk/v1. Mudanças incompatíveis só numa nova major.
Marketplace (/api/v1/*): cookie de sessão. SDK (/sdk/v1/*): bearer sk_ (no backend). Catálogo (/api/public/*): sem auth.
Erros: { error: { code, message } }.

Endpoints adicionados; o contrato de cupons abaixo inclui as correções de setembro de 2026:

POST /api/v1/affiliations/{id}/coupon — reserva permanente do código (4 a 20 caracteres A-Z0-9, único na plataforma), sem criar desconto. Troca de código é recusada.
O anunciante pode reservar códigos de afiliações existentes por POST /api/v1/programs/{id}/coupons/backfill e sincronizar cada cupom explicitamente por POST /api/v1/programs/{id}/coupons/{affiliationId}/sync. Só couponUsable: true indica cupom disponível.
Comissões e repasses somente em BRL; ciclo real e cliente novo exigem prova, com motivos de inelegibilidade em /api/v1/advertiser/diagnostics.
POST /api/v1/me/password — define a primeira senha da conta (quem entrou por link, código ou Google). Recusa senha vazada e só vale na janela logo após o login.
GET /api/v1/advertiser/conversions agora traz commissionCents e commissionStatus em cada venda.
GET /api/v1/affiliations agora traz couponEnabled do programa.

Adições compatíveis de setembro e outubro de 2026, sem mudança de major:

POST /sdk/v1/referral — o backend registra o cadastro do indicado; venda sem ref casa pelo cliente do gateway ou pelo e-mail dentro do prazo pós-cadastro do programa (padrão 90 dias).
GET /api/v1/advertiser/referrals — cadastros indicados do programa (com exportação CSV no painel).
GET /api/v1/advertiser/retorno — retorno do programa por mês e por afiliado: receita indicada, comissão, clientes novos e custo por cliente novo.
POST /sdk/v1/coupon/attribution — atribuição por cupom validado no checkout próprio do SaaS (AbacatePay).
POST /sdk/v1/affiliate/coupon — reserva do código do afiliado pelo backend do SaaS.

Lançamento do marketplace multi-gateway:

Catálogo público — programas e perfis de SaaS.
Marketplace — anunciantes, SaaS, programas, afiliações, contratos, analytics, gateways, repasses.
Integrações de pagamento — Stripe e Mercado Pago (OAuth); Pagar.me, Asaas e AbacatePay (API-key).
Tracking — redirect /go/<code>, atribuição last-click com refund-hold e clawback.
SDK do widget — /sdk/v1/affiliate, /stats e afs.js.
Webhooks — ingestão autenticada, idempotente, com fila e DLQ.

Homologação externa dos adaptadores e da reconciliação já implementados; testes com fixtures não comprovam vendas reais.