Алоқадор API

Сизнинг аффилланган ҳисоботингизни, тавсияларингизни, комиссияларингизни ва тўловларингизни ўқинг, тўловлар параметрларини ўзгартиринг ва тўловни талаб қилинг. Ҳар бир охирги нуқта API токени эгаси бўлган аффилланган ҳисобда ишлайди.

Tugash nuqtalari 7 endpoints

Asosiy yo'l /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`	Алоқа дастурига қўшилинг. Payout_method (paypal ёки stripe) ни paypal_email ёки stripe_account_id билан юборинг.

Реферал, комиссия ва тўловлар рўйхати саҳифаланган: ҳар бир жавобда ҳисоб, кейинги, олдинги ва натижалар бор. Уларни айланиш учун page ва ҳар бир саҳифада қанча нарса борлигини ўзгартириш учун page_size ни ишлатинг. Пул қийматлари ўнлик сонлар қатори сифатида қайтарилади. page_size: 25 (default), 100 (max)

OLING /api/v1/affiliates/me/

Сизнинг Affiliate Recordsингизни олиш

Namunaviy so'rov

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

Javob namunasi

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

Javob maydonlari

Асосий	Turi	Тасвирлаш
`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"
    }
  ]
}

Javob holati kodlari

200	Муваффақият
403	API токен йўқ ёки нодуруст, ёки токенда талаб қилинган рухсат йўқ
404	Бу ҳисоб ҳали ҳам алоқадор эмас

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

Ҳар бир охирги нуқта учун машина ўқийдиган спецификация, шу жумладан қуйидагилар ҳам, қуйида келтирилган ва сиз уни API манба саҳифасида интерактив равишда кўришингиз мумкин.

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

Ҳисоб учун тезлик чегараси: 1000 / hour

VPS.org API