Агенттиктердин 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`	Партнердик программага кошулуу. Пайдалануучуга 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-токен жок же жараксыз, же токендин керектүү уруксаты жок
404	Бул эсептик жазуусу азырынча филиал эмес

OpenAPI спецификациясы

Ар бир аяктоо пункту үчүн, анын ичинде бул пункттар үчүн, компьютерге окула турган спецификация төмөнкүдөй, аны API reference page сайтында интерактивдүү түрдө карап чыгууга болот.

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

Каттоо эсебинин ылдамдыгын чектөө: 1000 / hour

VPS.org API