VPS.org API

REST API dokumentacija

Affiliates API

Pročitaj svoj partnerski zapis, preporuke, provizije i isplate, promijeni postavke isplate i zatraži isplatu. Svaka krajnja tačka djeluje na partnerski račun koji posjeduje API token.

Krajnje tačke 7 endpoints
Osnovni put /api/v1/affiliates

Krajnje tačke i opseg tokena

Napravite token u računu, zatim Developers, i dajte mu opseg koji je potreban krajnjim tačkama ispod. Račun koji nije pridružen dobija 404 od svake krajnje tačke osim registracije.

Krajnja tačka Opseg Opis
GET /affiliates/me/affiliates:readVaša affiliate evidencija, bilanca i referal link
GET /affiliates/referrals/affiliates:readRačuni koji su se prijavili preko vašeg linka
GET /affiliates/commissions/affiliates:readCommissions earned on your referrals' payments
GET /affiliates/payouts/affiliates:readZahtijevana i plaćena isplata
PATCH /affiliates/settings/affiliates:updatePromijeni način isplate, PayPal email, Stripe račun ili minimalni iznos isplate min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createZatraži isplatu svog salda kada dosegne svoj minimum. Samo jedna čekajuća isplata u isto vrijeme.
POST /affiliates/signup/affiliates:createPridružite se partnerskom programu. Pošaljite payment_method (paypal ili stripe) sa paypal_email ili stripe_account_id.

Liste preporuka, provizija i isplata su stranicirane: svaki odgovor ima broj, sljedeći, prethodni i rezultate. Koristite page da se krećete kroz njih i page_size da promijenite koliko stavki svaka stranica sadrži. Novčane vrijednosti se vraćaju kao decimalni nizovi. page_size: 25 (default), 100 (max)

DOBITI /api/v1/affiliates/me/

Get Your Affiliate Record

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
statusstringsamo aktivni partneri mogu zatražiti isplate.
commission_ratedecimal stringKomisija kao postotak, a ne kao djelić 20.00 = 20%
cookie_daysintegerKoliko dana se klik na vaš link pamti
balancedecimal stringZasluženo i još neisplaćeno
total_earned / total_paiddecimal stringDoživotna provizija zarađena i doživotni iznos isplaćen

Preporuke, provizije i isplate

Svaka stavka u rezultatima ima ova polja:

Krajnja tač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 preporuke je čekanje, aktivan ili otkazan. Status provizije je čekanje, odobreno, plaćeno ili otkazano. Status isplate je čekanje, obrada, završeno ili neuspješ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"
    }
  ]
}

Kodovi statusa odgovora

200 Uspjeh
403 Nedostaje ili nije valjan API token, ili token nema potrebne dozvole
404 Ovaj račun još nije povezan

OpenAPI specifikacija

Mašinski čitljiva specifikacija za svaku krajnju tačku, uključujući i ove, je ispod, i možete je pregledati interaktivno na API referentnoj stranici.

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

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