I-API ye-Affiliates

Funda irekhodi lakho lokuxhumana, izixhumanisi, amakomidi kanye nemali, shintsha izilungiselelo zakho zokuxhumana futhi ucele imali. Ingxenye ngayinye isebenza ku-akhawunti yokuxhumana ephethe i-API token.

Amaphoyinti Okugcina 7 endpoints

Indlela Eyisisekelo /api/v1/affiliates

Izinkomba zesiphelo kanye ne-Token Scopes

Dala i-token ku-Account, bese ku-Developers, futhi unikeza izigaba ezidingayo iziqephu ezingezansi. I-akhawunti engaxhunyiwe ithola i-404 kusuka kunoma yisiphi isiqephu esisha ngaphandle kokubhalisa.

Ingxenye yendawo	Izinga	Incazelo
`GET /affiliates/me/`	`affiliates:read`	Irekhodi lakho le-affiliate, i-balance kanye ne-referral link
`GET /affiliates/referrals/`	`affiliates:read`	Ama-akhawunti abhalisiwe nge-link yakho
`GET /affiliates/commissions/`	`affiliates:read`	I-commission etholakele ku-referral yakho
`GET /affiliates/payouts/`	`affiliates:read`	Imali ekhokhwayo
`PATCH /affiliates/settings/`	`affiliates:update`	Tshintsha indlela yokukhokha, i-PayPal email, i-akhawunti ye-Stripe noma inani elincane lokukhokha `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Thola ukukhokha kwezimali zakho uma zifinyelela ku-minimum yakho. Ukhokha okungomunye kuphela olindelekile ngasikhathi sinye.
`POST /affiliates/signup/`	`affiliates:create`	Ukungena izinhlelo affiliate. Thumela payout_method (paypal noma stripe) nge paypal_email noma stripe_account_id.

Izinsiza, izivumelwano kanye nezibalo zokukhokha zihlukaniswe ngezigaba: impendulo ngayinye iqukethe inani, okulandelayo, okudlule kanye nemiphumela. Sebenzisa ikhasi ukuzulazula ngazo futhi page_size ukushintsha inani lezinto ngayinye ikhasi lizigcina. Amaxabiso emali abuyiselwa njengezinhlamvu zeshumi. page_size: 25 (default), 100 (max)

THOLA /api/v1/affiliates/me/

Thola irekhodi lakho le-Affiliate

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Izinkambu Zempendulo

Isigaba	Uhlobo	Incazelo
`status`	string	ilindelekile, isebenza, ihlehlisiwe noma iphele. Abahlanganyeli abasebenza kuphela abangakwazi ukufuna ukukhokha.
`commission_rate`	decimal string	I-commission njengephesenti, hhayi njengengxenye `20.00 = 20%`
`cookie_days`	integer	Ingabe unyaka wonke ucindezela kuxhumano lwakho lukhumbula
`balance`	decimal string	Itholakele futhi ayikho ikhokhwe
`total_earned` / `total_paid`	decimal string	I-commission yesikhathi sokuphila etholakele kanye nenani lokuphila elikhokhiwe

Izinkokhelo, amakomishini nama-payouts

Ingxenye ngayinye emiphumela inezindawo ezilandelayo:

Ingxenye yendawo	Isigaba
`/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`

Isimo sokulethwa silindelwe, sisebenza noma silahlekile. Isimo sekomishini silindelwe, sivunyelwe, sikhokhwe noma silahlekile. Isimo sokulethwa silindelwe, siqhubekekiswa, siqediwe noma sihlulekile.

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

Amakhodi Esimo Sempendulo

200	Uphumelela
403	I-API token elahlekile noma engasebenziyo, noma i-token ayinayo imvume edingekayo
404	Le akhawunti ayikho i-affiliate

Ulwazi olukhethekile lwe-OpenAPI

I-spec efundeka yi-machine yendawo ngayinye yokuqeda, kufaka phakathi lezi, ingezansi, futhi ungayibheka ngokuxhuma kwikhasi lokubhekisa le-API.

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

Ibanga le-rate ngalinye le-akhawunti: 1000 / hour

VPS.org API