Skip to main content
GET
Consultar Afiliado

Endpoint

Este endpoint retorna todos os detalhes de um afiliado específico, incluindo suas estatísticas de conversões e comissões.
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

Solução: Verifique se o header X-API-Key está correto e se a chave está ativa.

404 - Afiliado Não Encontrado

Causas possíveis:
  • O ID do afiliado não existe
  • O afiliado não está associado à campanha da sua API Key
  • O afiliado foi deletado
Solução: Verifique se o ID está correto e se o afiliado pertence à sua campanha.
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

Solução: O ID deve ser um número inteiro válido.

429 - Rate Limit

Solução: Aguarde 60 segundos antes de tentar novamente.

Casos de Uso

Antes de enviar conversões, você pode consultar o afiliado para verificar se ele existe e está ativo.
Use este endpoint para sincronizar informações do afiliado entre seu sistema e o Affiliatus.
Construa dashboards personalizados com estatísticas detalhadas de cada afiliado.
Consulte regularmente para monitorar conversões e comissões de afiliados específicos.
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 que totalCommissions 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