सहभाग API

अंतबिंदू व टोकन क्षेत्र

ॲकाऊंट, डेव्हलपर मध्ये टोकन तयार करा, आणि खालील अंतबिंदूची आवश्यकता असलेल्या क्षेत्रात देऊ करा. एक अ‍ॅफिलिएट नसलेले खाते नोंदणी वगळता प्रत्येक अंतबिंदूपासून 404 प्राप्त करते.

अंतबिंदू	क्षेत्र	वर्णन@ title: window
`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 सह payment_method (PayPal किंवा Stripe) पाठवा.

संदर्भ, शुल्क व देयके यादी पानबद्ध केली जाते: प्रत्येक प्रतिसादात संख्या, पुढील, पूर्वीचे व परिणाम आहेत. त्याद्वारे चालण्यासाठी पान वापरा व प्रत्येक पान किती घटक ठेवते ते बदलविण्याकरीता page_size वापरा. पैसे मूल्य दशलक्ष स्ट्रिंग्स म्हणून परत केले जाते. page_size: 25 (default), 100 (max)

मिळवा /api/v1/affiliates/me/

Get Your Affiliate Record

उदाहरण विनंती

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

प्रतिसाद फील्ड

क्षेत्र	प्रकार	वर्णन@ title: window
`status`	string	अद्याप चालू, सक्रीय, स्थगित किंवा समाप्त. फक्त सक्रीय सहभागदारांनाच पैसे देण्याची विनंती करता येते.
`commission_rate`	decimal string	टक्केवारीने कमीशन, भाग नाही `20.00 = 20%`
`cookie_days`	integer	तुमच्या लिंकवर क्लिक केल्यावर किती दिवस लक्षात राहते
`balance`	decimal string	प्राप्त झाले व अजूनही दिले गेले नाही
`total_earned` / `total_paid`	decimal string	आयुष्यभर कमिशन मिळवले आणि आयुष्यभर रक्कम भरली

Referrals, Commissions and Payouts

परिणामातील प्रत्येक घटकाचे हे क्षेत्र आहे:

अंतबिंदू	क्षेत्र
`/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 वर्णन

प्रत्येक वेळी ऍप डाउनलोड करताना, आपण त्या ऍपचे नाव आणि त्याचे ऍप स्टोरवर उपलब्ध असलेले स्थान कळवावे.

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

दर खाते करीता दर मर्यादा: 1000 / hour

VPS.org API