Холбоо 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`	Холбоо барих хөтөлбөрт нэгдээрэй. PayPal_email эсвэл stripe_account_id-тэй payment_method (paypal эсвэл stripe) илгээнэ үү.

Холбоо барих, комисс, төлбөрийн жагсаалтууд хуудаслагддаг: хариу бүрт тоо, дараагийн, өмнөх, үр дүн байдаг. Хуудас ашиглан эдгээрийг гүйлгэж, хуудасны хэмжээг хуудасны тоог өөрчлөхөд ашиглана. Төлбөр нь аравтын тоогоор буцаагддаг. 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-ийн түлхүүр алга, эсвэл хүчингүй, эсвэл түлхүүр нь шаардлагатай эрхийг агуулаагүй
404	Энэ данс одоогоор холбоогүй

OpenAPI тодорхойлолт

Энэхүү бүх төгсгөлийн цэгийн машин уншигдах тодорхойлолт доорх зурагт харагдаж байгаа бөгөөд та API-ийн холбоос хуудаснаас үүнийг харах боломжтой.

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

Тооцооны хэмжээ: 1000 / hour

VPS.org API