Skip to main content

​
Visão Geral

A API de Afiliados permite que você gerencie programaticamente todos os aspectos dos afiliados em suas campanhas. Com ela, você pode:
  • Criar novos afiliados
  • Listar afiliados com filtros e paginação
  • Consultar detalhes de um afiliado específico
  • Atualizar informações de afiliados
  • Remover afiliados da campanha

​
Autenticação

Todos os endpoints de afiliados requerem autenticação via API Key. A API Key deve ser enviada no header X-API-Key de cada requisição. 
X-API-Key: sua_api_key_aqui
Escopo da API Key: As operações de afiliados são limitadas aos afiliados associados à campanha da API Key. Você só pode acessar e gerenciar afiliados da campanha vinculada à sua API Key.

​
Limites do Plano

O número de afiliados que você pode criar é limitado pelo seu plano:
PlanoLimite de Afiliados por Campanha
Starter50 afiliados
Pro500 afiliados
PremiumIlimitado
Se você tentar criar um afiliado e já atingiu o limite do seu plano, receberá um erro 403 Forbidden.

​
Rate Limiting

Todos os endpoints de afiliados têm rate limit de 70 requisições por minuto por API Key. Se exceder o limite, você receberá um erro 429 Too Many Requests. Aguarde 60 segundos antes de tentar novamente.

​
Estrutura de um Afiliado

Um objeto afiliado contém as seguintes informações: 
{
  "id": 123,
  "name": "João Silva",
  "email": "[email protected]",
  "phone": "+55 11 99999-9999",
  "referralId": "JOAO1234",
  "status": "active",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "totalConversions": 45,
  "totalCommissions": 2500.0,
  "totalPaid": 1200.0
}

​
Campos

  • id: Identificador único do afiliado
  • name: Nome do afiliado (opcional)
  • email: E-mail do afiliado (único por campanha)
  • phone: Telefone do afiliado (opcional)
  • referralId: Código de referência único (usado para rastreamento)
  • status: Status do afiliado (pending, active ou inactive)
  • createdAt: Data de criação do afiliado
  • totalConversions: Número total de conversões geradas
  • totalCommissions: Valor total de comissões (aprovadas + pagas)
  • totalPaid: Valor total já pago ao afiliado
O campo password nunca é retornado nas respostas da API por motivos de segurança.

​
Endpoints Disponíveis

Criar Afiliado

Adicione um novo afiliado à sua campanha

Listar Afiliados

Liste todos os afiliados com filtros e paginação

Consultar Afiliado

Obtenha detalhes de um afiliado específico

Atualizar Afiliado

Atualize informações de um afiliado

Deletar Afiliado

Remova um afiliado da campanha

​
Boas Práticas

Se não fornecer um referralId na criação, o sistema gera um automaticamente. Porém, é recomendado usar códigos personalizados que sejam fáceis de identificar (ex: JOAO123, MARIA_INFLUENCER).
O e-mail deve ser único por campanha. Valide antes de enviar para evitar erros de conflito.
A senha deve ter no mínimo 6 caracteres. Recomendamos senhas com 8+ caracteres incluindo letras, números e símbolos.
  • Use pending para afiliados aguardando aprovação (auto-cadastro) - Use active para afiliados aprovados que podem gerar conversões - Use inactive para desativar temporariamente um afiliado sem deletá-lo, preservando o histórico
Para grandes listas de afiliados, use os parâmetros page e limit para otimizar a performance.
Use os filtros status e search para encontrar afiliados específicos rapidamente.

​
Próximos Passos

Criar API Key

Gere sua API key no dashboard

Enviar Eventos

Rastreie conversões dos seus afiliados

Dashboard

Visualize estatísticas no dashboard

Suporte

Entre em contato conosco