API pre affiliates

Prečítajte si svoj partnerský záznam, odporúčania, provízie a platby, zmeňte nastavenia platieb a požiadajte o platbu.Každý koncový bod pôsobí na partnerský účet, ktorý vlastní API token.

Koncové body 7 endpoints

Základná cesta /api/v1/affiliates

Koncové body a Token Scopes

Vytvorte token v časti Account (Účet) a potom Developers (Vývojári) a priraďte mu rozsahy, ktoré koncové body nižšie potrebujú.Účet, ktorý nie je pridružený, dostane kód 404 zo všetkých koncových bodov okrem registrácie.

Koncový bod	Rozsah pôsobnosti	Opis
`GET /affiliates/me/`	`affiliates:read`	Váš partnerský záznam, zostatok a odkaz na odporúčanie
`GET /affiliates/referrals/`	`affiliates:read`	Účty, ktoré sa zaregistrovali prostredníctvom vášho odkazu
`GET /affiliates/commissions/`	`affiliates:read`	Provízie získané z platieb vašich odporúčaní
`GET /affiliates/payouts/`	`affiliates:read`	Požadované a vyplatené platby
`PATCH /affiliates/settings/`	`affiliates:update`	Zmena spôsobu platby, PayPal e-mailu, Stripe účtu alebo minimálnej výšky platby `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Požiadajte o výplatu svojho zostatku, keď dosiahne minimálnu výšku.Naraz môžete požiadať o výplatu iba jedného čakajúceho výberu.
`POST /affiliates/signup/`	`affiliates:create`	Pošlite nám payment_method (paypal alebo stripe) s paypal_email alebo stripe_account_id a my Vám zašleme odkaz na vytvorenie účtu.

Zoznamy odporúčaní, provízií a platieb sú stránkované: každá odpoveď má počet, ďalšiu, predchádzajúcu a výsledky. Použite page na pohyb medzi nimi a page_size na zmenu počtu položiek na každej stránke. Hodnoty peňazí sú vrátené ako desatinné reťazce. page_size: 25 (default), 100 (max)

ZÍSKAŤ /api/v1/affiliates/me/

Získajte svoj affiliate záznam

Príklad žiadosti

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

Príklad odpovede

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

Polia odpovede

Pole	Typ	Opis
`status`	string	Iba aktívni partneri môžu požiadať o platbu, ktorá je závislá od ich účtu.
`commission_rate`	decimal string	Provízia v percentách, nie v zlomkoch `20.00 = 20%`
`cookie_days`	integer	Koľko dní sa kliknutie na váš odkaz zapamätá
`balance`	decimal string	Zarobené a ešte nevyplatené
`total_earned` / `total_paid`	decimal string	Doživotná provízia získaná a doživotná suma vyplatená

Odporúčania, provízie a výplaty

Každá položka vo výsledkoch má tieto polia:

Koncový bod	Pole
`/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`

Stav odporúčania je čakanie, aktívne alebo zrušené. Stav provízie je čakanie, schválené, zaplatené alebo zrušené. Stav platby je čakanie, spracovanie, dokončené alebo zlyhanie.

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

Kódy stavu odpovede

200	Úspech
403	Chýbajúci alebo neplatný token API alebo token nemá požadované povolenie
404	Tento účet ešte nie je pridružený

OpenAPI Specification (po anglicky)

Strojovo čitateľná špecifikácia pre každý koncový bod vrátane týchto je uvedená nižšie a môžete ju interaktívne prehľadávať na referenčnej stránke rozhrania API.

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

Limit sadzieb na účet: 1000 / hour

VPS.org API