सम्बद्धहरू API

आफ्नो संबद्ध रेकर्ड पढ्न, सिफारिस, आयोग र payouts, आफ्नो payout सेटिङ परिवर्तन र एक payout अनुरोध. हरेक अन्त बिन्दु 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 इमेल, स्ट्रिप खाता वा न्यूनतम भुक्तानी राशि `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	यो आफ्नो न्यूनतम पुग्दा एक पटक आफ्नो शेष को एक भुक्तानी अनुरोध। एक समयमा मात्र एक बाँकी भुक्तानी।
`POST /affiliates/signup/`	`affiliates:create`	संबद्ध कार्यक्रम सामेल। paypal_email वा stripe_account_id संग payout_method पठाउनुहोस् (PayPal वा स्ट्रिप)।

प्रत्येक प्रतिक्रिया गणना छ, अर्को, अघिल्लो र परिणाम: को सन्दर्भ, आयोग र भुक्तानी सूची paginated छन्। तिनीहरूलाई मार्फत सार्न र page_size प्रत्येक पृष्ठ कति वस्तुहरू परिवर्तन गर्न पृष्ठ प्रयोग। पैसा मूल्य दशमलव स्ट्रिङ रूपमा फिर्ता छन्। 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	बाँकी, सक्रिय, निलम्बित वा समाप्त। केवल सक्रिय संबद्ध payouts अनुरोध गर्न सक्नुहुन्छ।
`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	यो खाता अझै पनि एक संलग्नता होइन

खुला एपीआई निर्दिष्टीकरण

प्रत्येक अन्त बिन्दु लागि मेसिन-पढ्न योग्य स्पेक, यी सहित, तल छ, र तपाईं एपीआई सन्दर्भ पृष्ठ मा अन्तरक्रियात्मक रूपमा ब्राउज गर्न सक्नुहुन्छ।

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

प्रति खाता दर सीमा: 1000 / hour

VPS.org API