Affiliati API

Leghje u vostru record affiliatu, rifirimenti, cumissioni è pagamenti, cambiate e vostre impostazioni di pagamentu è dumandemu un pagamentu. Ogni endpoint agisce nantu à u contu affiliatu chì posside u token API.

Punti finali 7 endpoints

Percorsu di Base /api/v1/affiliates

Punti finali e spaziu di token

Crea un token in Account, poi Developers, è dàcilu l'ambiti di i punti finali sottu bisognu. Un contu chì ùn hè micca affiliatu ottiene 404 da ogni puntu finali eccettu l'iscrizione.

Puntu finali	Ambitu	Descrizzioni
`GET /affiliates/me/`	`affiliates:read`	U vostru record di affiliazione, saldo e link di rifirimentu
`GET /affiliates/referrals/`	`affiliates:read`	Cunti ca s'hannu iscrittu cu lu vostru ligami
`GET /affiliates/commissions/`	`affiliates:read`	Cummissioni guadagnati supra li pagamenti di li vostri rifirimenti
`GET /affiliates/payouts/`	`affiliates:read`	Pagamenti richiesti e pagati
`PATCH /affiliates/settings/`	`affiliates:update`	Cambia u metudu di pagamentu, l'email PayPal, u contu Stripe o l'importu minimu di pagamentu `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Richiedi un pagamentu dû to saldu quannu ghjunghji u minimu. Sulu un pagamentu in attesa à la volta.
`POST /affiliates/signup/`	`affiliates:create`	Invià payout_method (PayPal o striscia) cù paypal_email o stripe_account_id.

Li liste di rifirimenti, cummissioni e pagamenti sunnu paginati: ogni risposta havi u conte, u prossimu, u pricidenti e li risultati. Usa page pi spustassi tra i liste e page_size pi canciari lu numaru di elementi ca ogni pagina cunteni. I valuri di soldi sunnu riturnati comu stringhi dicimali. page_size: 25 (default), 100 (max)

OTTIENI /api/v1/affiliates/me/

Otteni u vostru Record Affiliatu

Esempiu di dumanda

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);

Esempiu di risposta

{
  "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"
}

Campi di risposta

Campu	Tipu	Descrizzioni
`status`	string	Affiliates sò in attesa, attiva, sospesa o terminata. solu affiliati attivi ponu dumandà pagamenti.
`commission_rate`	decimal string	Cummissioni comu na pircintuali, nun comu na frazzioni `20.00 = 20%`
`cookie_days`	integer	Quanti ghjorni si ricorda un clicu supra lu vostru ligami
`balance`	decimal string	Guadagnatu e nun ancora pagatu
`total_earned` / `total_paid`	decimal string	Cummissioni à vita guadagnata e quantità à vita pagata

Riferimenti, Cummissioni e Pagamenti

Ogni elementu di li risultati havi sti campi:

Puntu finali	Campu
`/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`

U statu di rifirimentu è in attesa, attiva o annullata. U statu di cummissione è in attesa, approvata, pagata o annullata. U statu di pagamentu hè in attesa, processata, completata o fallita.

{
  "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"
    }
  ]
}

Codici di Statu di Risposta

200	Successu
403	Token API mancante o nun validu, o u token nun havi li permessi richiesti
404	Stu contu nun è ancora un affiliatu

Specificazioni OpenAPI

A speca leggibbili da a màchina pi ogni puntu finali, cumpresi sti, è sutta, e si pò parrari dintrattivamenti ntâ pàggina di rifirimentu API.

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

Limite di tassi per contu: 1000 / hour

VPS.org API