VPS.org API

REST API ஆவணமாக்கல்

இணைப்புகள் 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 மின்னஞ்சல், ஸ்ட்ரைப் கணக்கு அல்லது குறைந்தபட்ச செலுத்தும் தொகை 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: 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"
}

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
statusstringநடப்பு, செயலில், நிறுத்தப்பட்ட அல்லது முடிக்கப்பட்டது. செயல்படும் உறுப்பினர்கள் மட்டுமே பணம் செலுத்த வேண்டி இருக்கும்.
commission_ratedecimal stringகம்மிஷன் விகிதமாக, பிரிவு அல்ல 20.00 = 20%
cookie_daysintegerஉங்கள் இணைப்பில் க்ளிக் செய்தால் எவ்வளவு நாட்கள் நினைவில் வைக்கப்படும்
balancedecimal stringசம்பாதித்த மற்றும் இன்னும் செலுத்தப்படாத
total_earned / total_paiddecimal 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