Affiliates API ကို

သင်၏အဆက်အသွယ်မှတ်တမ်းဖတ်ပါ, referrals, ကော်မရှင်နှင့်ငွေပေးချေမှု, သင့်ရဲ့ငွေပေးချေမှု settings ကိုပြောင်းလဲခြင်းနှင့်ငွေပေးချေမှုတောင်းဆို. အားလုံး endpoint API ကို token ကိုပိုင်ဆိုင်သောအဆက်အသွယ်အကောင့်အပေါ်လုပ်ဆောင်.

အဆုံးမှတ်များ 7 endpoints

အခြေခံလမ်းကြောင်း /api/v1/affiliates

Endpoints နှင့် Token နယ်ပယ်

Account ထဲမှာ token ကိုဖန်တီး, ထို့နောက် Developers, နှင့်အောက်တွင် endpoints လိုအပ်သောအောက်တွင်သက်ရောက်မှုပေး. တစ်ဦးအဆက်အသွယ်မဟုတ်တဲ့အကောင့်ကို gets 404 signup ကလွဲပြီးအားလုံး endpoint မှ 404.

အဆုံးသတ်ချက်	သက်ရောက်မှု	ဖော်ပြချက်
`GET /affiliates/me/`	`affiliates:read`	သင့်ရဲ့အဆက်အသွယ်မှတ်တမ်း, ငွေကြေးနှင့်အကြံပြု link ကို
`GET /affiliates/referrals/`	`affiliates:read`	သင့်ရဲ့လင့်ကနေတဆင့်မှတ်ပုံတင်ထားတဲ့အကောင့်များ
`GET /affiliates/commissions/`	`affiliates:read`	သင့်ရဲ့ referrals 'ပေးချေမှုအပေါ်ရယူ commissions
`GET /affiliates/payouts/`	`affiliates:read`	တောင်းဆိုနှင့်ပေးဆောင် Payouts
`PATCH /affiliates/settings/`	`affiliates:update`	ငွေပေးချေမှုနည်းလမ်းကိုပြောင်းလဲ, PayPal ကိုအီးမေးလ်, Stripe အကောင့်သို့မဟုတ်အနည်းဆုံးငွေပေးချေမှုအရေအတွက် `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	သင့်အနည်းဆုံးငွေပမာဏကိုရောက်ရှိပြီးနောက်သင့်ရဲ့ငွေစုငွေချေးမှုကိုတောင်းဆိုပါ။ တစ်ချိန်တည်းမှာသာတစ်ဦးစောင့်ဆိုင်းငွေပေးချေမှု။
`POST /affiliates/signup/`	`affiliates:create`	အဆက်အသွယ်အစီအစဉ်ကို join. paypal_email သို့မဟုတ် stripe_account_id နှင့်အတူ payout_method ပေးပို့ (paypal သို့မဟုတ် stripe) ။

အဆိုပါအကြံပြုချက်များ, ကော်မရှင်နှင့်ငွေပေးချေမှုစာရင်း paginated နေကြသည်: တစ်ခုချင်းစီကိုတုံ့ပြန်မှုစာရင်းရှိပါတယ်, နောက်တစ်ခု, ယခင်နှင့်ရလဒ်များကို. အသုံးပြုပုံစာမျက်နှာတစ်ဦးချင်းစီစာမျက်နှာပိုင်ဆိုင်ဘယ်လောက်ပစ္စည်းများပြောင်းလဲရန်သူတို့ကိုဖြတ်ပြီးသွားရန်နှင့် page_size. ငွေတန်ဖိုးများကိုဆယ်ပုံတစ်ပုံ strings အဖြစ်ပြန်လာကြသည်. page_size: 25 (default), 100 (max)

ရယူပါ /api/v1/affiliates/me/

သင်၏ Affiliate Record ကို Get

နမူနာတောင်းဆိုချက်

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	pendent, တက်ကြွ, ရပ်ဆိုင်းသို့မဟုတ်ရပ်ဆိုင်း. တက်ကြွအပေါင်းအပါများသာငွေပေးချေမှုတောင်းဆိုနိုင်ပါတယ်.
`commission_rate`	decimal string	တစ်ရာခိုင်နှုန်းအဖြစ်ကော်မရှင်, တစ်စိတ်တစ်ပိုင်းမဟုတ် `20.00 = 20%`
`cookie_days`	integer	သင့်ရဲ့လင့်ခ်ပေါ်တွင်ကလစ်နှိပ်ခြင်းကိုမှတ်မိသည်ဘယ်နှစ်ရက်
`balance`	decimal string	ရရှိပြီး ထုတ်ပေးခြင်းမရှိသေး
`total_earned` / `total_paid`	decimal string	ဘဝ commission ရရှိပြီး ဘဝငွေပမာဏပေးချေ

တင်ပြချက်များ, ကော်မရှင်နှင့် 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`

Referral status သည် စောင့်ဆိုင်းနေသည်, တက်ကြွစွာ သို့မဟုတ် ပယ်ဖျက်ထားသည်။ Commission status သည် စောင့်ဆိုင်းနေသည်, ခွင့်ပြုချက်ရထားသည်, ပေးချေထားသည် သို့မဟုတ် ပယ်ဖျက်ထားသည်။ Payout status သည် စောင့်ဆိုင်းနေသည်, စီမံခန့်ခွဲမှု, ပြီးစီးခဲ့သည် သို့မဟုတ် ပျက်ကွက်ခဲ့သည်။

{
  "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 သတ်မှတ်ချက်

ဤအပါအဝင်, အားလုံး endpoints များအတွက်စက်-ဖတ်နိုင် spec အောက်တွင်ဖြစ်ပါသည်, သင် API ကိုအကြံပြုစာမျက်နှာပေါ်တွင် interaction ကိုရှာဖွေနိုင်ပါတယ်.

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

အကောင့်တစ်ကြိမ်နှုန်းအဆုံးသတ်: 1000 / hour

VPS.org API