VPS.org API

API- документација

Афилира 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 е- пошта, стрипе сметка или минимален износ на исплата min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createБараме исплата од вашата рамнотежа кога ќе достигне минимален број.
POST /affiliates/signup/affiliates:createПриклучи се до програмата за асоцијација. Испрати payout_ method (паypal или лента) со paypal_ email или trip_ 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"
}

Полиња за одговор

Поле Тип Опис
statusstringСамо активните асоцијали можат да бараат исплата.
commission_ratedecimal stringКомисија како процент, а не разлошок 20.00 = 20%
cookie_daysintegerКолку дена се памти кликот на вашата врска
balancedecimal stringЗаработен и сеуште не исплатен
total_earned / total_paiddecimal 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