رابطہ دار 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`	ادائگی کا طریقہ بدلیں، PayPal ای میل، 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) بھیجیں۔

ريفريشن ، کميشن اور پيز ائيز فہرست صفحات پر هيں: ہر جواب ميں شمار ، بعدي ، سابق اور نتيجے هے ان ميں سے گزرنے کے ليے صفحہ استعمال کريں اور صفحہ کي سائز کو تبديل کريں هر صفحے ميں کتني ايٹم هيں رقمي قيمتي عشاري سترينج کے طور پر واپس کريں page_size: 25 (default), 100 (max)

حاصل کریں۔ /api/v1/affiliates/me/

آپ کا Affiliate ریکارڈ حاصل کریں

مثال کی درخواست

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	یہ اکاؤنٹ ابھی تک ایک وابستہ نہیں ہے

اوپن API وضاحت

ہر ایک انتہا پوائنٹ کے لئے مشین پڑھنے والی وضاحت، ان کے ساتھ، نیچے ہے، اور آپ اسے API حوالہ صفحے پر باہمی طور پر براؤز کرسکتے ہیں۔

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

ہر اکاؤنٹ کے لیے ریت حد: 1000 / hour

VPS.org API