Afiliati API

Preberite svoj affiliate rekord, napotitve, provizije in izplačila, spremenite svoje izplačilo nastavitev in zahtevajo izplačilo. Vsak opazovani dogodk deluje na affiliate računu, ki je lastnik API žeton.

Končne točke 7 endpoints

Osnovna pot /api/v1/affiliates

Končni točki in področja uporabe

Ustvarite žeton v računu, potem razvijalci, in mu dajo področje uporabe, ki so spodaj potrebni. Račun, ki ni affiliate dobi 404 od vsakega opazovanja, razen prijave.

Končna točka	Področje uporabe	Opis
`GET /affiliates/me/`	`affiliates:read`	Vaša podružnica rekord, ravnotežje in napotitev povezava
`GET /affiliates/referrals/`	`affiliates:read`	Računi, ki so se prijavili skozi vašo povezavo
`GET /affiliates/commissions/`	`affiliates:read`	Komisija, ki je zaslužila plačila vaših zaprosil
`GET /affiliates/payouts/`	`affiliates:read`	Zahtevane in plačane izplačila
`PATCH /affiliates/settings/`	`affiliates:update`	Spremeni metodo izplačila, e-poštnega programa PayPal, računa Stripe ali minimalnega zneska izplačila `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Zahtevajte izplačilo ravnovesja, ko dosežete minimalno. Samo eno izplačilo naenkrat.
`POST /affiliates/signup/`	`affiliates:create`	Pridružite se affiliate programu. Pošljite payout_method (paypal ali prug) s paypal_email ali strip_account_id.

Napotila, provizije in izplačila seznami so paginirani: vsak odziv je štel, naslednji, prejšnji in rezultati. Uporabite stran, da se premika skozi njih in stran_size spremeni koliko postavk ima vsaka stran. Vrednosti denarja se vrnejo kot decimalne nize. page_size: 25 (default), 100 (max)

PRIDOBITE /api/v1/affiliates/me/

Priskrbi svojo pomočno evidenco

Primer zahteve

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

Primer odgovora

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

Polja za odgovor

Polje	Vrsta	Opis
`status`	string	V teku, aktivno, odloženo ali prekinjeno. Samo aktivne podružnice lahko zahtevajo izplačila.
`commission_rate`	decimal string	Komisija v odstotkih, ne pa v zlomu `20.00 = 20%`
`cookie_days`	integer	Koliko dni se spomni klik na vašo povezavo
`balance`	decimal string	Zasluženo in še ni izplačano
`total_earned` / `total_paid`	decimal string	Zaslužena provizija za življenje in izplačana življenjska doba

Navedbe, Komisije in plačila

Vsaka postavka v rezultatih ima ta polja:

Končna točka	Polje
`/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`

Status napotitve je v čakanju, aktivno ali preklicano. Status Komisije je v čakanju, odobren, plačan ali preklican. Status plačila je v čakanju, obdelava, dokončan ali neuspešno.

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

Kode stanja odgovora

200	Uspeh
403	Manjkajoči ali neveljavni API žeton, ali token manjka zahtevano dovoljenje
404	Ta račun še ni podružnica

Specifikacija OpenAPI

Specifikacija za vsak opazovani dogodek, vključno s temi, je spodaj in jo lahko interaktivno brskate na referenčni strani API.

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

Omejitev stopnje na račun: 1000 / hour

VPS.org API