Афилиатски 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`	Присъединете се към филиалната програма. Изпрати payout_method (паypal или ивици) с paypal_email или pay_account_id.

Препратките, комисиизплащане на списъци са пагинирани: всеки отговор има броя, следващ, предишни и резултати. Използвайте страница, за да се премести през тях и 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 референтната страница.

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

Ограничение на лихвите на сметката: 1000 / hour

VPS.org API