ຄູ່ຮ່ວມງານ API

ອ່ານບັນທຶກຄູ່ຮ່ວມງານຂອງທ່ານ, ແນະນໍາ, ຄ່າທໍານຽມແລະເງິນຝາກ, ປ່ຽນການຕັ້ງຄ່າການຈ່າຍເງິນຂອງທ່ານແລະຂໍເງິນຝາກ. ທຸກຈຸດສຸດທ້າຍປະຕິບັດໃນບັນຊີຄູ່ຮ່ວມງານທີ່ເປັນເຈົ້າຂອງ API token.

ຈຸດສິ້ນສຸດ 7 endpoints

ເສັ້ນທາງພື້ນຖານ /api/v1/affiliates

ຈຸດຈົບ ແລະ ເຂດຂອງໂຕກັ່ນ

ສ້າງ token ໃນບັນຊີ, ຫຼັງຈາກນັ້ນຜູ້ພັດທະນາ, ແລະໃຫ້ມັນກັບຈຸດສຸດທ້າຍທີ່ຕ້ອງການຂ້າງລຸ່ມນີ້. ບັນຊີທີ່ບໍ່ແມ່ນຄູ່ຮ່ວມງານໄດ້ຮັບ 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.

ຄໍາແນະນໍາ, ຄ່າທໍານຽມແລະລາຍຊື່ການຈ່າຍເງິນແມ່ນ paginated: ຄໍາຕອບແຕ່ລະຄົນມີຈໍານວນ, ຕໍ່ໄປ, ກ່ອນຫນ້ານີ້ແລະຜົນໄດ້ຮັບ. ນໍາໃຊ້ຫນ້າເພື່ອເຄື່ອນຍ້າຍຜ່ານພວກເຂົາແລະ page_size ເພື່ອປ່ຽນແປງຈໍານວນຫຼາຍຂອງລາຍການແຕ່ລະຫນ້າຖື. ຄ່າເງິນແມ່ນກັບຄືນມາເປັນ strings ຕົວເລກ decimal. page_size: 25 (default), 100 (max)

ຮັບ /api/v1/affiliates/me/

ໄດ້ຮັບບັນທຶກ Affiliate ຂອງທ່ານ

ຕົວຢ່າງການຮ້ອງຂໍ

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	ຄ່າທໍານຽມຊີວິດທີ່ຫາໄດ້ແລະຈໍານວນຊີວິດທີ່ຈ່າຍອອກ

ແນະນໍາ, ຄ່າທໍານຽມແລະຈ່າຍ

ທຸກໆລາຍການໃນຜົນການຄົ້ນຫາມີພື້ນທີ່ດັ່ງນີ້:

ຈຸດສຸດທ້າຍ	ແຄມເປນ
`/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`

ສະຖານະການແນະນໍາແມ່ນລໍຖ້າ, ເຄື່ອນໄຫວຫຼືຍົກເລີກ. ສະຖານະການ commission ແມ່ນລໍຖ້າ, ອະນຸມັດ, ຈ່າຍຫຼືຍົກເລີກ. ສະຖານະການຈ່າຍເງິນແມ່ນລໍຖ້າ, ຂະບວນການ, ສໍາເລັດຫຼືລົ້ມເຫລວ.

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

VPS.org API