Affiliates API

Přečtěte si svůj affiliate záznam, referrals, provize a výplaty, změnit nastavení výplaty a požádat o výplatu. Každý cílový parametr působí na affiliate účet, který vlastní API token.

Koncové body 7 endpoints

Základní cesta /api/v1/affiliates

Koncové body a symbolická oblast působnosti

Vytvořit žeton v účtu, pak vývojáři, a dát mu rozsahy cílové hodnoty níže potřebují. Účet, který není affiliate dostane 404 z každého koncového bodu kromě přihlášení.

Konečný bod	Oblast působnosti	Popis zboží
`GET /affiliates/me/`	`affiliates:read`	Váš affiliate záznam, zůstatek a referral odkaz
`GET /affiliates/referrals/`	`affiliates:read`	Účty, které se zapsaly přes váš odkaz
`GET /affiliates/commissions/`	`affiliates:read`	Komise, které byly získány na vašich pověřovacích listinách
`GET /affiliates/payouts/`	`affiliates:read`	Požadované a zaplacené výplaty
`PATCH /affiliates/settings/`	`affiliates:update`	Změnit způsob výplaty, PayPal email, Stripe účet nebo minimální výši výplaty `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Žádám o výplatu vašeho zůstatku, jakmile dosáhne vašeho minima.
`POST /affiliates/signup/`	`affiliates:create`	Přidejte se k affiliate programu. Odeslat výplatu_metody (paypal nebo pruh) s paypal_email nebo stripe_account_id.

Seznamy referralů, provizí a výplat jsou paginovány: každá odpověď má počet, další, předchozí a výsledky. Pomocí stránky pro pohyb přes ně a strana_size změnit, kolik položek každá stránka drží. Peníze hodnoty jsou vráceny jako desetinné řetězce. page_size: 25 (default), 100 (max)

ZÍSKAT /api/v1/affiliates/me/

Získejte svůj partnerský záznam

Příklad žádosti

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

Příklad odpovědi

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

Pole odpovědí

Pole	Typ	Popis zboží
`status`	string	Vyřešeno, aktivní, pozastaveno nebo ukončeno. Pouze aktivní pobočky mohou požádat o výplaty.
`commission_rate`	decimal string	Komise jako procento, nikoli zlomek `20.00 = 20%`
`cookie_days`	integer	Kolik dní kliknutí na odkaz je zapamatován
`balance`	decimal string	Vyděláno a dosud nevypláceno
`total_earned` / `total_paid`	decimal string	Vyplacená celoživotní provize a vyplacená doživotní částka

Poradenství, komise a výplaty

Každá položka ve výsledcích má tato pole:

Konečný 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`

Postoupení se nevyřeší, aktivní nebo zrušená. Stav Komise je dosud v platnosti, schválen, zaplacen nebo zrušen. Výplata je v platnosti, zpracována, dokončena nebo neúspěšná.

{
  "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 odpovědi

200	Úspěch
403	Chybí nebo neplatná API žeton, nebo žeton postrádá požadované povolení
404	Tento účet ještě není affiliate

Specifikace OpenAPI

Strojově čitelný spec pro každý cílový parametr, včetně těchto, je níže, a můžete jej interaktivně prohlížet na referenční stránce API.

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

Limit sazby na účet: 1000 / hour

VPS.org API