ส่วนร่วม API

อ่านบันทึกของผู้ร่วมธุรกิจของคุณ แนะนำ ค่าคอมมิชชั่นและเงินจ่าย เปลี่ยนการตั้งค่าการจ่ายเงินของคุณ และขอรับเงินจ่าย ทุกจุดสุดท้ายปฏิบัติต่อบัญชีผู้ร่วมธุรกิจที่เป็นเจ้าของ API โต๊ก

จุดสิ้นสุด 7 endpoints

เส้นทางฐาน /api/v1/affiliates

จุดจบและพื้นที่ของท็อคเกอร์

สร้างท็อกเกอร์ใน Account, แล้วก็ Developers และให้พื้นที่ที่จุดจบด้านล่างต้องการกับมัน บัญชีที่ไม่ใช่ผู้ร่วมงาน จะได้รับ 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`	เข้าร่วมโปรแกรมพันธมิตร ส่ง payment_method (paypal หรือ stripe) กับ paypal_email หรือ stripe_account_id

รายการการแนะนำ, ค่าบริการ และค่าชดเชย จะถูกจัดเป็นหน้า: ทุกคำตอบจะมีจำนวน, ถัดไป, ก่อนหน้า และผลลัพธ์ ใช้ page เพื่อย้ายไปยังหน้านั้น ๆ และใช้ 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"
}

ช่องตอบกลับ

ช่อง	พิมพ์	คำอธิบาย
`status`	string	รอ, ทำงาน, หยุดชะงัก หรือ ยกเลิก เพียงแค่ผู้ร่วมงานที่ทำงานเท่านั้นที่สามารถขอรับเงิน
`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`

สถานะการแนะนำเป็น รอ, ทำงาน หรือยกเลิก สถานะค่าคอมมิชชั่นเป็น รอ, อนุมัติ, จ่าย หรือยกเลิก สถานะการจ่ายเป็น รอ, ประมวลผล, เสร็จสิ้น หรือล้มเหลว

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