API Affiliates

Прочитайте ваші дані щодо сплати за рахунками, реферансами, комісійними та виплатами, змініть ваші параметри сплати і попросіть про виплату. Всі дії з кінцевою точкою буде виконано на рахунках, які належать до ключа 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, рахунок Смужки або мінімальну суму сплати `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Вимагайте виплати за ваш баланс, коли вона досягне мінімуму. Лише один з них виплачує одночасно.
`POST /affiliates/signup/`	`affiliates:create`	Приєднатися до програми, що виконується з афішами. Надіслати команду reendout_ method (pagepal або barpal) за допомогою Paypal_ email або spool_ account_ id.

Список рефералів, комісій і сплат за сплатим буде створено так: кожна відповідь рахується, наступний, попередній і результат. Скористайтеся сторінкою, щоб пересуватися цими списками і розміром сторінки, щоб змінити кількість елементів, які зберігаються на кожній сторінці. Значення грошей буде повернуто у вигляді десяткових рядків. 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