API liên kết

Đọc hồ sơ liên kết, giới thiệu, lãi và trả, thay đổi thiết lập trả và yêu cầu trả. Mỗi điểm cuối hoạt động trên tài khoản liên kết sở hữu token API.

Điểm cuối 7 endpoints

Đường cơ sở /api/v1/affiliates

Điểm cuối và phạm vi token

Tạo một token trong Tài khoản, sau đó là Nhà phát triển, và cho nó phạm vi mà các điểm cuối dưới đây cần. Một tài khoản không liên kết sẽ nhận được 404 từ mọi điểm cuối ngoại trừ đăng ký.

Điểm kết thúc	Phạm vi	Mô tả
`GET /affiliates/me/`	`affiliates:read`	Hồ sơ liên kết, số dư và liên kết giới thiệu của bạn
`GET /affiliates/referrals/`	`affiliates:read`	Tài khoản đăng ký qua liên kết của bạn
`GET /affiliates/commissions/`	`affiliates:read`	Thưởng từ việc trả tiền cho người giới thiệu của anh
`GET /affiliates/payouts/`	`affiliates:read`	Đã yêu cầu và trả tiền
`PATCH /affiliates/settings/`	`affiliates:update`	Thay đổi phương pháp thanh toán, email PayPal, tài khoản Stripe hoặc số tiền thanh toán tối thiểu `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Yêu cầu thanh toán số dư khi nó đạt đến mức tối thiểu. Chỉ một lần thanh toán đang chờ.
`POST /affiliates/signup/`	`affiliates:create`	Đăng ký chương trình liên kết. Gửi phương pháp_ thanh toán (paypal hoặc stripe) với paypal_email hoặc stripe_account_id.

Danh sách các liên kết, tiền thưởng và tiền trả được phân trang: mỗi câu trả lời có số, tiếp theo, trước và kết quả. Dùng page để di chuyển qua chúng và page_ size để thay đổi số mục mỗi trang chứa. Giá trị tiền được trả lại như chuỗi thập phân. page_size: 25 (default), 100 (max)

LẤY /api/v1/affiliates/me/

Lấy hồ sơ liên kết của bạn

Ví dụ về yêu cầu

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);

Ví dụ về câu trả lời

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

Các trường phản hồi

Địa điểm	Kiểu	Mô tả
`status`	string	Chỉ có các công ty liên kết hoạt động mới có thể yêu cầu trả tiền.
`commission_rate`	decimal string	Chỉ số là phần trăm, không phải là phần trăm `20.00 = 20%`
`cookie_days`	integer	Có bao nhiêu ngày một lần nhấn vào liên kết của bạn được nhớ
`balance`	decimal string	Tưởng đã có và chưa trả
`total_earned` / `total_paid`	decimal string	Tổng số tiền được nhận và số tiền được trả

Đánh giá, ủy quyền và trả tiền

Mỗi mục trong kết quả có các trường sau:

Điểm kết thúc	Địa điểm
`/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`

Tình trạng giới thiệu đang chờ, đang hoạt động hoặc đã hủy bỏ. Tình trạng tiền thưởng đang chờ, đã chấp thuận, đã trả hoặc đã hủy bỏ. Tình trạng trả tiền đang chờ, đang xử lý, đã hoàn thành hoặc thất bại.

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

Mã trạng thái phản hồi

200	Thành công
403	Thiếu hoặc không hợp lệ token API, hoặc token không có quyền cần thiết
404	Tài khoản này chưa phải là tài khoản liên kết

Đặc tả OpenAPI

Sự đặc tả đọc máy cho mỗi điểm cuối, bao gồm cả những thứ này, là dưới đây, và bạn có thể lướt qua nó tương tác trên trang tham khảo API.

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

Giới hạn tốc độ mỗi tài khoản: 1000 / hour

VPS.org API