АПИ филиалов

Прочитай свою запись, направление, комиссионные и выплаты, измени свои условия выплаты и запроси платеж. Каждый конечный пункт действует на аффилированном счете, который владеет символом 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`	Изменение метода выплаты, почтовая почта, Аккаунт в полосе или минимальная сумма выплаты `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Просите выплатить вам остаток, как только он достигнет вашего минимума.
`POST /affiliates/signup/`	`affiliates:create`	Присоединиться к программе филиала. Отправить платеж в размере_метод (paypal или полоска) с помощью платного_mail или стрип_ccount_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`

Referral status is pending, active or cancelled. Commission status is pending, approved, paid or cancelled. Payout status is pending, processing, completed or failed.

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