Afiliados API

Leia o seu registro de afiliados, encaminhamentos, comissões e pagamentos, altere suas configurações de pagamento e solicitar um pagamento. Cada endpoint atua na conta de afiliados que possui o token API.

Pontos finais 7 endpoints

Caminho base /api/v1/affiliates

Âmbitos finais e de toque

Crie um token na Conta, então Desenvolvedores, e lhe dá os escopos os endpoints abaixo de necessidade. Uma conta que não é uma afiliada recebe 404 de cada ponto final, exceto inscrição.

Ponto final	Âmbito de aplicação	Descrição
`GET /affiliates/me/`	`affiliates:read`	Seu registro de afiliados, equilíbrio e link de referência
`GET /affiliates/referrals/`	`affiliates:read`	Contas que se inscreveram através de seu link
`GET /affiliates/commissions/`	`affiliates:read`	As Comissãos ganharam sobre os seus pagamentos de encaminhamentos
`GET /affiliates/payouts/`	`affiliates:read`	Pagamentos solicitados e pagos
`PATCH /affiliates/settings/`	`affiliates:update`	Alterar o método de pagamento, e-mail PayPal, conta de stripe ou valor mínimo de pagamento `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Solicite um pagamento do seu saldo uma vez que chega ao seu mínimo.
`POST /affiliates/signup/`	`affiliates:create`	Junte-se ao programa de afiliados. Enviar pagamento_método (paypal ou stripe) com paypal_email ou stripe_account_id.

As listas de referências, comissões e pagamentos são paginadas: cada resposta tem conta, próximo, anterior e resultados. Use página para mover através deles e page_size para alterar o número de itens que cada página possui. Os valores de dinheiro são devolvidos como cadeias decimais. page_size: 25 (default), 100 (max)

PEGAR /api/v1/affiliates/me/

Obtenha o seu registro de filiação

Exemplo de solicitação

cURL

Python

JavaScript

curl -X GET "https://admin.vps.org/api/v1/affiliates/me/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests

headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
base = "https://admin.vps.org/api/v1/affiliates"

me = requests.get(f"{base}/me/", headers=headers).json()
print(me["balance"], me["total_earned"])

# Walk every page of commissions
url = f"{base}/commissions/?page_size=100"
while url:
    page = requests.get(url, headers=headers).json()
    for c in page["results"]:
        print(c["created_at"], c["amount"], c["status"])
    url = page["next"]

const res = await fetch('https://admin.vps.org/api/v1/affiliates/me/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});
const me = await res.json();
console.log(me.balance, me.referral_url);

Exemplo de resposta

{
  "uuid": "9f2c4e7a1b3d4c5e8f6a7b8c9d0e1f2a",
  "user_email": "you@example.com",
  "referral_code": "AB12CD34",
  "referral_url": "https://vps.org/?ref=AB12CD34",
  "status": "active",
  "commission_rate": "20.00",
  "cookie_days": 90,
  "payout_method": "paypal",
  "paypal_email": "you@example.com",
  "stripe_account_id": null,
  "min_payout_amount": "10.00",
  "balance": "42.50",
  "total_earned": "142.50",
  "total_paid": "100.00",
  "created_at": "2026-09-01T12:00:00Z"
}

Campos de resposta

Campo	Tipo	Descrição
`status`	string	pendente, ativa, suspensa ou terminada. Só as afiliadas ativas podem solicitar pagamentos.
`commission_rate`	decimal string	Comissão em percentagem, não uma fracção `20.00 = 20%`
`cookie_days`	integer	Quantos dias um clique no seu link é lembrado
`balance`	decimal string	Apercebido e ainda não pago
`total_earned` / `total_paid`	decimal string	Comisão de vida ganhada e montante de vida pago

Referências, comissões e pagamentos

Cada item em resultados tem estes campos:

Ponto final	Campo
`/affiliates/referrals/`	`uuid, referred_email, status, created_at`
`/affiliates/commissions/`	`uuid, referred_email, amount, rate, original_amount, status, created_at`
`/affiliates/payouts/`	`uuid, amount, method, status, created_at, processed_at, error_message`

O estatuto de referência está pendente, ativa ou cancelada. O estatuto da Comissão está pendente, aprovada, paga ou cancelada. O estatuto de pagamento está pendente, processado, completado ou falecido.

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3b1e9c0d2a4f4e6b8c7d5e4f3a2b1c0d",
      "referred_email": "customer@example.com",
      "amount": "2.00",
      "rate": "20.00",
      "original_amount": "10.00",
      "status": "approved",
      "created_at": "2026-09-20T08:15:00Z"
    }
  ]
}

Códigos de status de resposta

200	Sucesso
403	Ficha API faltante ou inválida, ou o token carece da permissão requerida
404	Esta conta ainda não é uma afiliada

Especificação OpenAPI

A especificação legível por máquina para cada ponto final, incluindo estes, está abaixo, e você pode navegá-lo interativamente na página de referência API.

https://admin.vps.org/api/v1/schema/

Taxa limite por conta: 1000 / hour

VPS.org API