Consultar Afiliado
Afiliados
Consultar Afiliado
Obtenha detalhes completos de um afiliado específico
GET
Consultar Afiliado
Endpoint
Escopo: Você só pode consultar afiliados que pertencem à campanha da sua API Key.
Autenticação
string
required
Sua API key obtida no dashboard em Configurações → API Keys
Path Parameters
number
required
ID do afiliado que você deseja consultar
Response
number
ID único do afiliado
string
Nome do afiliado
string
E-mail do afiliado
string
Telefone do afiliado
string
Código de referência único
string
Status do afiliado (
pending, active ou inactive)string
Data de criação (ISO 8601)
number
Número total de conversões geradas pelo afiliado
number
Valor total de comissões (aprovadas + pagas) em BRL
number
Valor total já pago ao afiliado em BRL
Exemplos
Consultar Afiliado por ID
Resposta de Sucesso (200 OK)
Erros
401 - API Key Inválida
X-API-Key está correto e se a chave está ativa.
404 - Afiliado Não Encontrado
- O ID do afiliado não existe
- O afiliado não está associado à campanha da sua API Key
- O afiliado foi deletado
Segurança: Por motivos de segurança, a API não revela se um afiliado existe em outra campanha. Sempre retorna a mesma mensagem de erro.
400 - ID Inválido
429 - Rate Limit
Casos de Uso
Validar se afiliado existe
Validar se afiliado existe
Antes de enviar conversões, você pode consultar o afiliado para verificar se ele existe e está ativo.
Sincronizar dados
Sincronizar dados
Use este endpoint para sincronizar informações do afiliado entre seu sistema e o Affiliatus.
Dashboard personalizado
Dashboard personalizado
Construa dashboards personalizados com estatísticas detalhadas de cada afiliado.
Verificar performance
Verificar performance
Consulte regularmente para monitorar conversões e comissões de afiliados específicos.
Auditoria
Auditoria
Use para auditar e verificar se os valores de comissões estão corretos antes de efetuar pagamentos.
Entendendo as Estatísticas
totalConversions
Conta todas as conversões do afiliado nesta campanha, independente do status (pending, approved, rejected, paid).totalCommissions
Soma das comissões apenas de conversões aprovadas e pagas. Não inclui conversões pendentes ou rejeitadas.totalPaid
Valor já transferido para o afiliado através de payouts com status paid. Pode ser menor quetotalCommissions se há comissões aprovadas ainda não pagas.
Exemplo de Cálculo
Próximos Passos
Atualizar Afiliado
Edite as informações do afiliado
Listar Afiliados
Veja todos os afiliados
Enviar Conversões
Rastreie conversões do afiliado
Deletar Afiliado
Remova o afiliado da campanha

