Affiliati API

Pročitajte svoj affiliate rekord, referanse, provizije i isplate, promijenite svoje isplate postavke i tražiti isplatu. Svaki ishod djeluje na affiliate računu koji posjeduje API žeton.

Krajnje točke 7 endpoints

Osnovni put /api/v1/affiliates

Krajnjim točkama i područjem primjene

Napravite žeton u računu, zatim Razvojnici, i dati mu opseg ishoda ispod potrebe. Račun koji nije affiliate dobiva 404 od svakog ishoda osim prijave.

Krajnji točki	Područje primjene	Opis
`GET /affiliates/me/`	`affiliates:read`	Vaš affiliate rekord, ravnoteža i referentna veza
`GET /affiliates/referrals/`	`affiliates:read`	Korisnički računi koji su se prijavili kroz vaš link
`GET /affiliates/commissions/`	`affiliates:read`	Komisija je dobila na plaćanju vaših upućivanja
`GET /affiliates/payouts/`	`affiliates:read`	Zahtjev i plaćanje isplata
`PATCH /affiliates/settings/`	`affiliates:update`	Promijenite način isplate, PayPal e-mail, Stripe račun ili minimalni iznos isplate `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Zahtjeva isplatu vašeg stanja kada dođe do vašeg minimalnog. Samo jedan u čekanju isplata u isto vrijeme.
`POST /affiliates/signup/`	`affiliates:create`	Pridružite se programu affiliate. Pošaljite payout_method (paypal ili pruga) s paypal_email ili pruga_account_id.

Upute, provizije i isplate liste su paginirani: svaki odgovor ima brojanje, sljedeći, prethodni i rezultati. Koristite stranicu za pomicanje kroz njih i page_size da promijenite koliko stavki svaka stranica sadrži. Vrijednosti novca se vraćaju kao decimalne nizove. page_size: 25 (default), 100 (max)

DOBITI /api/v1/affiliates/me/

Donesi svoj afilijski zapis

Primjer zahtjeva

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

Primjer 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	Tip	Opis
`status`	string	U čekanju, aktivnom, suspendiranom ili prekinutom. Samo aktivni podružnici mogu tražiti isplate.
`commission_rate`	decimal string	Komisija kao postotak, a ne razlomak `20.00 = 20%`
`cookie_days`	integer	Koliko dana klik na vaš link se pamti
`balance`	decimal string	Zasluženo i još nije isplaćeno
`total_earned` / `total_paid`	decimal string	Doživotna provizija zarađena i iznos isplaćen

Zahtjevi, Komisije i isplate

Svaki predmet u rezultatima ima ova polja:

Krajnji točki	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`

Uvjeti za upućivanje su u čekanju, aktivni ili otkazani. Status Komisije je u čekanju, odobren, plaćen ili otkazan. Status isplate je u čekanju, obrada, završetak ili neuspjeh.

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

Kodovi statusa odgovora

200	Uspjeh
403	Nedostaje ili neispravan API žeton, ili token nedostaje potrebna dozvola
404	Ovaj račun još nije podružnica

OpenAPI specifikacija

Strojno čitava specifikacija za svaki ishod, uključujući i ove, je ispod, i možete ga interaktivno pregledati na API referentnoj stranici.

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

Ograničenje stope po računu: 1000 / hour

VPS.org API