Affiliates API

Dhammaan iyo Token

abuuro calaamad Account, ka dibna horumariyayaal, oo siiya waajibaadka ay dhamaadka hoos u baahan yihiin. xisaab aan aheyn mid la xiriira ka helaa 404 ka mid ah dhamaadka kasta oo ka baxsan diiwaangelinta.

Xarafka	Xeerka	Tilmaamaha
`GET /affiliates/me/`	`affiliates:read`	Your record affiliate, miisaanka iyo xiriirka soo jeedinta
`GET /affiliates/referrals/`	`affiliates:read`	xisaabaadka oo ka diiwaan gashan xiriirka
`GET /affiliates/commissions/`	`affiliates:read`	Komishanka ku kasbatay lacagaha ku soo jeediyay
`GET /affiliates/payouts/`	`affiliates:read`	Lacagta la dalbaday iyo la bixiyey
`PATCH /affiliates/settings/`	`affiliates:update`	Isbedelka habka lacag bixinta, emailka PayPal, xisaabta Stripe ama lacag bixinta ugu yar `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Wixii lacag ah oo aad ku dalbato miisaaniyaddaada marka ay gaarto ugu yaraankaaga. Hal lacag oo kaliya oo la sugayo oo waqti kasta.
`POST /affiliates/signup/`	`affiliates:create`	Ku biir barnaamijka la xiriira. Dib u soo dir payout_method (PayPal ama stripe) la paypal_email ama stripe_account_id.

The soo jeedinta, guddiga iyo liiska lacagaha la bixiyo waa pageted: jawaab kasta oo ay tirada, soo socda, hore iyo natiijooyinka. U isticmaali kartaa bogga si ay u wareegaan iyaga iyo page_size si ay u beddelaan sida wax badan oo waxyaabaha bog kasta oo haysta. Qiimaha lacag la soo celiyey sida strings decimal. page_size: 25 (default), 100 (max)

HEL /api/v1/affiliates/me/

Ka hel Your Affiliate Record

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Goobaha Jawaabta

Isku-darka	Nooca	Tilmaamaha
`status`	string	la sugayo, active, joojiyey ama la joojiyay. kaliya la xiriira active waxay codsan karaan lacagaha.
`commission_rate`	decimal string	Guddiga sida boqolkiiba, ma qayb `20.00 = 20%`
`cookie_days`	integer	Tirada maalmood ee riixid ku saabsan xiriirka aad la xusuusto
`balance`	decimal string	La kasbaday oo aan weli la bixin
`total_earned` / `total_paid`	decimal string	Lifetime komishanka la siiyay iyo nolosha lacag la siiyay

Soo jeedinta, Guddiga iyo Payouts

Wax kasta oo ka mid ah natiijooyinka waxaa ka mid ah meelaha:

Xarafka	Isku-darka
`/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`

Xaalada soo jeedinta waa la sugayaa, oo hawlan ama la joojiyay. Xaalada Guddiga waa la sugayaa, oo la ansixiyay, la bixiyey ama la joojiyay. Xaalada lacag bixinta waa la sugayaa, la xallin, la dhammeeyay ama fashilmay.

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

Koodhadhka Xaaladda Jawaab celinta

200	Guul
403	Xiran ama aan sharci ahayn API token, ama token ka maqan oggolaanshaha loo baahan yahay
404	xisaabtan ma aha mid la xiriira weli

OpenAPI

Spec mashiinka akhrin kara ee dhammaan dhamaadka, oo ay ku jiraan kuwani, waa hoos, oo waxaad ka arki kartaa si interactively on API page soo jeedinta.

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

Qiimaha xaddidaadda xisaabta: 1000 / hour

VPS.org API