Rafobase Logo

Referência de API

Documentação completa da API REST pública do Rafobase.

Referência de API

A API pública do Rafobase permite integrar seu frontend ou sistemas externos ao programa de indicação e creators.

Autenticação

Todas as requisições devem incluir o header X-API-Key com sua chave de API:

curl https://api.rafobase.com/api/v1/member/me?email=user@example.com \
  -H "X-API-Key: SUA_API_KEY"

Nunca exponha sua API Key no frontend. Use-a apenas em chamadas servidor-para-servidor.

Base URL

https://api.rafobase.com/api/v1

Endpoints

Membros

GET /member/me

Busca um membro existente ou cria automaticamente (quando autoCreate=true).

ParâmetroTipoDescrição
emailstringEmail do membro (obrigatório)
namestringNome do membro
externalIdstringID externo (do seu sistema)
autoCreateboolSe true, cria o membro caso não exista
curl "https://api.rafobase.com/api/v1/member/me?email=joao@example.com&name=Jo%C3%A3o&autoCreate=true" \
  -H "X-API-Key: SUA_API_KEY"

GET /member/referrals

Lista as indicações feitas pelo membro autenticado.

ParâmetroTipoDescrição
emailstringEmail do membro

Carteira

GET /wallet/balance

Consulta o saldo da carteira de um membro.

Retorna: totalEarned, totalRedeemed, available, pending, cancelled.


GET /wallet/transactions

Retorna o histórico de transações da carteira.


POST /wallet/redeem

Solicita o resgate do saldo disponível.


Creators

GET /creators/{token}

Retorna o perfil público de um creator pelo token.


GET /creators/{token}/tiers

Lista os tiers de comissão configurados para o creator.


GET /creators/{token}/sales

Retorna o histórico de vendas atribuídas ao creator.


Formato de Erro

Todas as respostas de erro seguem o formato:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Member not found"
  }
}

Códigos HTTP comuns:

CódigoDescrição
400Requisição inválida
401API Key ausente ou inválida
404Recurso não encontrado
500Erro interno do servidor

OpenAPI Spec

Para a especificação completa com schemas de request/response, consulte o endpoint OpenAPI:

GET https://api.rafobase.com/api/v1/openapi.json

On this page