Docs

Buscar na documentação

Guias, endpoints e eventos

Ir ao painel

Indicações e campanhas

Link de indicação de um cliente

Get-ou-create do código do indicador + recompensa + progresso. Escopo read.

curl "https://api.ribbo.app/v1/referrals/link?external_id=cliente-123" -H "Authorization: Bearer bk_..."
# ou ?email=

Resposta:

{ "active": true, "code": "ABC123", "token": "…", "link": "https://…",
  "reward": { "kind": "…", "value": 0, "cycles": 1, "currency": "brl", "label": "…" },
  "progress": { "total": 0, "qualified": 0, "rewarded": 0, "reverted": 0 } }

{"active": false} se não há programa de indicação.

Campanhas de renovação

Gerar (ou obter, idempotente) o link de renovação de um cliente do público-alvo. Escopo write (gera um documento pagável), mesmo sendo um GET.

curl "https://api.ribbo.app/v1/renewal-campaigns/rnc_01J…/link?external_id=cliente-123" -H "Authorization: Bearer bk_..."

Resposta { "token", "url", "price_cents", "bonus_cycles", "bonus_unit", "status", "starts_at", "offer_id", "plan_id", "product_id" }. starts_at no futuro = o link só é pagável a partir dessa data. 404 se o cliente não está no público da campanha.

Listar todos os links da campanha (cursor, escopo read):

curl "https://api.ribbo.app/v1/renewal-campaigns/rnc_01J…/links?limit=100" -H "Authorization: Bearer bk_..."