Пайвастагиҳо

Хондани сабти ҳамкории шумо, тавсияҳо, комиссияҳо ва пардохтҳо, тағир додани танзимоти пардохт ва дархости пардохт. Ҳар нуқтаи охирин дар ҳисоби ҳамкорӣ, ки дорои API-и token мебошад, амал мекунад.

Нуқтаҳои ниҳоӣ 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 усули пардохтро (paypal ё stripe) фиристед.

Рӯйхати фиристоданҳо, комиссияҳо ва пардохтҳо саҳифабандӣ шудаанд: ҳар як ҷавоб дорои ҳисоб, навбатӣ, пешина ва натиҷаҳо мебошад. Барои ҳаракат дар байни онҳо саҳифаро истифода баред ва 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 нест
404	Ин ҳисоб ҳанӯз ҳамроҳ нест

Муайянкунии OpenAPI

Маълумоти хондашавандаи мошин барои ҳар як нуқтаи охирин, аз ҷумла инҳо, дар поён оварда шудааст, ва шумо метавонед онро интерактивӣ дар саҳифаи истиноди API баррасӣ кунед.

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

Маҳдудияти суръати ҳар як ҳисоб: 1000 / hour

VPS.org API