Skip to main content
GET
/
v1
/
affiliates
/
{id}
Consultar Afiliado
curl --request GET \
  --url https://api.affiliatus.io/v1/affiliates/{id} \
  --header 'X-API-Key: <x-api-key>'
{
  "id": 123,
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "referralId": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "totalConversions": 123,
  "totalCommissions": 123,
  "totalPaid": 123
}

​
Endpoint

GET https://api.affiliatus.io/v1/affiliates/{id}
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

​
X-API-Key
string
required
Sua API key obtida no dashboard em Configurações → API Keys

​
Path Parameters

​
id
number
required
ID do afiliado que você deseja consultar

​
Response

​
id
number
ID único do afiliado
​
name
string
Nome do afiliado
​
email
string
E-mail do afiliado
​
phone
string
Telefone do afiliado
​
referralId
string
Código de referência único
​
status
string
Status do afiliado (pending, active ou inactive)
​
createdAt
string
Data de criação (ISO 8601)
​
totalConversions
number
Número total de conversões geradas pelo afiliado
​
totalCommissions
number
Valor total de comissões (aprovadas + pagas) em BRL
​
totalPaid
number
Valor total já pago ao afiliado em BRL

​
Exemplos

​
Consultar Afiliado por ID

curl -X GET "https://api.affiliatus.io/v1/affiliates/123" \
  -H "X-API-Key: sua_api_key_aqui"

​
Resposta de Sucesso (200 OK)

{
  "id": 123,
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "+55 11 99999-9999",
  "referralId": "JOAO123",
  "status": "active",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "totalConversions": 45,
  "totalCommissions": 2500.00,
  "totalPaid": 1200.00
}

​
Erros

​
401 - API Key Inválida

{
  "statusCode": 401,
  "message": "Invalid or inactive API Key",
  "error": "Unauthorized"
}
Solução: Verifique se o header X-API-Key está correto e se a chave está ativa.

​
404 - Afiliado Não Encontrado

{
  "statusCode": 404,
  "message": "Affiliate not found",
  "error": "Not Found"
}
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

{
  "statusCode": 400,
  "message": "Validation failed (numeric string is expected)",
  "error": "Bad Request"
}
Solução: O ID deve ser um número inteiro válido.

​
429 - Rate Limit

{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests",
  "error": "Too Many Requests"
}
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

Conversões Totais: 50
├─ 40 aprovadas → R$ 2.000 em comissões
├─ 5 pendentes → R$ 250 (não contam)
└─ 5 rejeitadas → R$ 250 (não contam)

Payouts Realizados:
├─ Payout #1: R$ 1.000 (pago)
└─ Payout #2: R$ 500 (pago)

Resultado:
├─ totalConversions: 50
├─ totalCommissions: 2000.00
└─ totalPaid: 1500.00

​
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