Membros
Entendendo membros - os clientes que participam do seu programa de indicação.
Membros
Membros são clientes que participam do seu programa de indicação como indicadores. Cada membro recebe um código de cupom único que pode compartilhar com outros.
Ciclo de Vida do Membro
Propriedades do Membro
| Propriedade | Tipo | Descrição |
|---|---|---|
id | string | Identificador único (UUID) |
email | string | Email do membro (único por merchant) |
name | string | Nome de exibição |
externalId | string | ID do cliente do seu sistema |
referralCode | string | Código de indicação único |
cpf | string | CPF do membro (opcional) |
phone | string | Telefone do membro (opcional) |
campaignId | string | Campanha associada |
status | enum | active, inactive, blocked |
wallet | object | Informações de saldo atual |
Criando Membros
Os membros podem ser criados de duas formas:
1. Via API (Recomendado)
Melhor para integração controlada onde você decide quem pode participar.
curl "https://api.rafobase.com/api/v1/member/me?email=customer@example.com&name=Jo%C3%A3o%20Silva&externalId=your_customer_id&campaignId=CAMPAIGN_UUID&autoCreate=true" \
-H "X-API-Key: $RAFOBASE_API_KEY"2. Criação Automática via API
Ao usar o parâmetro autoCreate=true na chamada da API, o membro é criado automaticamente caso ainda não exista.
A criação automática via autoCreate=true é útil para negócios de assinatura onde todo cliente
deve se tornar automaticamente um indicador.
Códigos de Cupom
Cada membro recebe um código de cupom único seguindo o padrão:
{PREFIXO}-{PARTE_DO_NOME}-{ALEATORIO}Exemplo: NUT-JOAOS-A7B3C
- PREFIXO: Seu prefixo de marca (configurado nas configurações)
- PARTE_DO_NOME: Primeiras 5 letras do nome do membro
- ALEATORIO: 5 caracteres hexadecimais aleatórios
O código de cupom é:
- Case-insensitive no checkout
- Validado contra sua plataforma de checkout
- Usado para atribuição (não como mecanismo de desconto por padrão)
Visão Geral da Carteira
Todo membro tem uma carteira associada com dois saldos:
- Pendente: Créditos de indicações recentes, ainda em período de garantia
- Disponível: Créditos que podem ser resgatados
Veja Carteira para informações detalhadas.
Status do Membro
| Status | Descrição |
|---|---|
active | Pode receber indicações e resgatar |
inactive | Temporariamente desabilitado |
blocked | Bloqueado por fraude ou violação de política |
Unificação Virtual (Mesmo CPF)
Quando múltiplas contas compartilham o mesmo CPF, o sistema identifica automaticamente uma conta principal — a primeira conta criada com aquele CPF. Todas as operações de carteira e consultas de saldo passam a usar essa conta principal, evitando fragmentação de saldo.
Como funciona
- A função
resolvePrincipal()busca todas as contas com o mesmo CPF - A conta criada primeiro (
createdAtmais antigo) é eleita como principal - Todas as consultas de saldo da carteira utilizam o ID da conta principal
- O código de indicação retornado nas respostas da API é o da conta principal
- Esse processo é transparente para o consumidor da API — não é necessária nenhuma ação adicional
Por que isso importa
Previne a fragmentação de saldo quando um cliente cria múltiplas contas com emails diferentes mas o mesmo CPF. Sem a unificação, os créditos ficariam espalhados entre contas distintas, dificultando o resgate e gerando confusão.
Exemplo
- Cliente cria conta com
email-1@example.com(CPF123.456.789-00) — essa se torna a conta principal - Mais tarde, cria outra conta com
email-2@example.comusando o mesmo CPF - Ao consultar qualquer uma das duas contas, o saldo retornado é o da conta principal
- O código de indicação retornado também é o da conta principal
A unificação por CPF é automática e não requer configuração. Basta garantir que o campo cpf
esteja preenchido na criação do membro para que o sistema faça a resolução corretamente.
Melhores Práticas
Dicas para Gerenciamento de Membros - Sempre use externalId para ligar membros ao seu
sistema - Configure criação automática via autoCreate=true para negócios de assinatura -
Monitore membros inativos e re-engaje-os - Revise membros bloqueados periodicamente
Relacionado
- Indicações - Como as indicações são rastreadas
- Carteira - Gerenciamento de saldo
- Referência de API - Endpoints de API