අනුබද්ධ API

ඔබේ අනුබද්ධ වාර්තා කියවන්න, නිර්දේශ, කොමිස් හා ගෙවීම්, ඔබේ ගෙවීම් සැකසුම් වෙනස් හා ගෙවීම් ඉල්ලා. සෑම අවසන් ස්ථානයක් API ටොකන් අයිති වන අනුබද්ධ ගිණුම මත ක්රියා.

අන්ත ලක්ෂ්‍ය 7 endpoints

පාදක මාර්ගය /api/v1/affiliates

අවසන් ස්ථානයන් සහ ටොකන් විෂය පථ

ගිණුම තුළ ටොකන් නිර්මාණය, පසුව සංවර්ධකයින්, හා පහත අවසාන අවශ්යතා විෂය පථ ලබා දෙන්න. අනුබද්ධ නොවන බව ගිණුමක් ලැබෙන 404 ලියාපදිංචි හැර සෑම අවසාන ස්ථානයක සිට.

අවසාන ස්ථානය	විෂය පථය	විස්තරය
`GET /affiliates/me/`	`affiliates:read`	ඔබේ අනුබද්ධ වාර්තා, ශේෂය සහ යොමු සබැඳිය
`GET /affiliates/referrals/`	`affiliates:read`	ඔබේ සබැඳිය හරහා ලියාපදිංචි වූ ගිණුම්
`GET /affiliates/commissions/`	`affiliates:read`	ඔබේ නිර්දේශිත ගෙවීම් මත උපයා කොමිස්
`GET /affiliates/payouts/`	`affiliates:read`	ඉල්ලා ඇති හා ගෙවනු ලැබූ ගෙවීම්
`PATCH /affiliates/settings/`	`affiliates:update`	ගෙවීම් ක්රම වෙනස්, පේපෑල් ඊ-තැපැල්, Stripe ගිණුම හෝ අවම ගෙවීම් මුදල `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	එය ඔබේ අවම ළඟා වූ විට ඔබේ ඉතිරි මුදල් ගෙවීම ඉල්ලා. එකවර එක් බලාපොරොත්තු විය හැකි ගෙවීමක් පමණක්.
`POST /affiliates/signup/`	`affiliates:create`	සම්බන්ධිත වැඩසටහනට එක්වන්න. paypal_email හෝ stripe_account_id සමග payout_method යවන්න (PayPal හෝ Stripe).

එක් එක් ප්රතිචාරය ගණන්, ඊළඟ, පෙර හා ප්රතිඵල ඇත: මෙම යොමු, කොමිසම් හා ගෙවීම් ලැයිස්තු paginated වේ. එක් එක් පිටුව පවත්වාගෙන කොපමණ අයිතම වෙනස් කිරීමට ඔවුන් හරහා ගමන් කිරීමට පිටුව භාවිතා page_size. මුදල් වටිනාකම් දශම strings ලෙස ආපසු ලැබේ. page_size: 25 (default), 100 (max)

ලබා ගන්න /api/v1/affiliates/me/

ඔබේ අනුබද්ධ වාර්තාව ලබා ගන්න

උදාහරණ ඉල්ලීම

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

උදාහරණ ප්‍රතිචාරය

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

ප්‍රතිචාර ක්ෂේත්‍ර

ක්ෂේත්‍රය	වර්ගය	විස්තරය
`status`	string	බලාපොරොත්තු, ක්රියාකාරී, අත්හිටුවන හෝ අවසන්. ක්රියාකාරී අනුබද්ධිත පමණක් ගෙවීම් ඉල්ලා කළ හැක.
`commission_rate`	decimal string	කොටසක් නොවේ, ප්රතිශතයක් ලෙස කොමිසම `20.00 = 20%`
`cookie_days`	integer	ඔබේ සබැඳිය මත ක්ලික් දින කීයක් මතක තබා ගන්න
`balance`	decimal string	උපයාගත් නමුත් තවම ගෙවා නොමැති
`total_earned` / `total_paid`	decimal string	ජීවිත කාලය පුරාම කොමිස් උපයා සහ ජීවන කාලය පුරාවට මුදල් ගෙවා

යොමු කිරීම්, කොමිසම් හා ගෙවීම්

ප්රතිඵල එක් එක් අයිතමය මෙම ක්ෂේත්ර ඇත:

අවසාන ස්ථානය	ක්ෂේත්‍රය
`/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`

යෝජනා තත්ත්වය බලාපොරොත්තුවෙන්, ක්රියාකාරී හෝ අවලංගු කර ඇත. කොමිසම තත්ත්වය බලාපොරොත්තුවෙන්, අනුමත, ගෙවීම් හෝ අවලංගු කර ඇත. ගෙවීම් තත්ත්වය බලාපොරොත්තුවෙන්, සැකසීම, සම්පූර්ණ හෝ අසාර්ථක වී ඇත.

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

ප්‍රතිචාර තත්ව කේත

200	සාර්ථකත්වය
403	අතුරුදන් හෝ වලංගු API ටොකන්, හෝ ටොකන් අවශ්ය අවසර නොමැත
404	මෙම ගිණුම තවමත් අනුබද්ධ නොවේ

OpenAPI පිරිවිතර

සෑම අවසාන ස්ථානය සඳහා යන්ත්‍ර-පරිශීලනය කළ හැකි පිරිවිතර, මෙම ඇතුළු, පහත සඳහන් වන අතර, ඔබ API උපුටා දැක්වීම පිටුව මත අන්තර් ක්රියාකාරීව එය ගවේෂණය කළ හැකිය.

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

ගිණුමකට අනුපාත සීමා: 1000 / hour

VPS.org API