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, គណនី Stripe ឬចំនួនទឹកប្រាក់ទូទាត់អប្បបរមា min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createស្នើសុំការទូទាត់ប្រាក់នៃសល់របស់អ្នកនៅពេលវាដល់អប្បបរមារបស់អ្នក។ មានតែការទូទាត់ប្រាក់មួយប៉ុណ្ណោះដែលរង់ចាំនៅពេលមួយ។
POST /affiliates/signup/affiliates:createចូលរួមកម្មវិធីដៃគូ។ ផ្ញើ payout_method (PayPal ឬ stripe) ជាមួយ paypal_email ឬ stripe_account_id ។

ការ​យោង, គណៈកម្មការ និង បញ្ជី ប្រាក់ រង្វាន់ ត្រូវ បាន ទំព័រ: ចម្លើយ នីមួយៗ មាន ចំនួន, បន្ទាប់, មុន និង លទ្ធផល. ប្រើ ទំព័រ ដើម្បី ផ្លាស់ ប្តូ រ តាមរយៈ ពួក គេ និង 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"
}

វាលឆ្លើយតប

វាល ប្រភេទ សេចក្ដី​ពិពណ៌នា
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 token ឬ​ token ខ្វះ​សិទ្ធិ​ដែល​ត្រូវការ
404 គណនី​នេះ​មិន​មែន​ជា​គណនី​ដែល​បាន​ភ្ជាប់​នៅ​ឡើយ​ទេ

ការ​បញ្ជាក់ OpenAPI

ម៉ាស៊ីន​អាន​បាន​បញ្ជាក់​សម្រាប់​ចំណុច​បញ្ចប់​នីមួយៗ​រួម​ទាំង​នេះ​គឺ​នៅ​ខាងក្រោម ហើយ​អ្នក​អាច​រក​មើល​វា​ដោយ​អន្តរកម្ម​នៅ​លើ​ទំព័រ​យោង API ។

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

ដែន​កំណត់​អត្រា​ក្នុង​មួយ​គណនី ៖ 1000 / hour