VPS.org API

Faʻamatalaga o le REST API

Faʻatonu

Read your affiliate record, referrals, commissions and payouts, change your payout settings and request a payout. Every endpoint acts on the affiliate account that owns the API token.

Fa'ai'uga 7 endpoints
Ala Autu /api/v1/affiliates

Faʻaiuga ma le faʻaputuga o faʻailoga

Fausia se faailoga i le Account, ona Developers, ma tuʻuina atu i ai le faʻaaogaina o le endpoints i lalo o le manaʻoga. O se teugatupe e le o se afiliata e maua ai le 404 mai i soʻo se endpoint e aunoa ma le tusi faʻamaonia.

Faʻaiuga Faʻavasegaina Faʻamatalaga
GET /affiliates/me/affiliates:readO lau faamaumauga afiliati, tupe teu ma le fesootaiga faasinomaga
GET /affiliates/referrals/affiliates:readFaʻamatalaga e faʻaaoga ai lau fesoʻotaʻiga
GET /affiliates/commissions/affiliates:readFaʻatupeina o le komisi i luga o le totogiina o au faʻatonu
GET /affiliates/payouts/affiliates:readFaʻatupeina talosagaina ma totogiina
PATCH /affiliates/settings/affiliates:updateSuia le auala totogi, imeli PayPal, teugatupe Stripe poʻo le aofaʻi maualalo o le totogiina min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createFaʻatonu se totogi o lau tupe teu pe a oʻo i le maualalo. E tasi le totogi e faʻatali i le taimi.
POST /affiliates/signup/affiliates:createFaatasi ai ma le polokalama afiliate. Auina payout_method (paypal po o stripe) ma paypal_email po stripe_account_id.

O le faasinomaga, komisi ma totogifuapauina o lisi o le a paginated: o le a i ai i soo se tali numera, mulimuli, muamua ma aafiaga. Faaaoga le itulau e fealuai i latou ma page_size e suia le tele o mea i so o se itulau e i ai. tupe tau o loo toe i ai i le tulaga o strings decimal. page_size: 25 (default), 100 (max)

MAUA /api/v1/affiliates/me/

Faʻatonu lau Affiliate Record

Talosaga Fa'ata'ita'i

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);

Tali Fa'ata'ita'i

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

Fanua Tali

Aoga Ituaiga Faʻamatalaga
statusstringfaaauau pea, faaaogāina, faanofoesea po o le faaiuga. E mafai ona talosagaina totogifuapauina e tagata auai faaaogāina.
commission_ratedecimal stringKomisi e pei o se pasene, e le o se vaega 20.00 = 20%
cookie_daysintegerO le a le tele o aso e manatuaina ai se kiliki i lau sootaga
balancedecimal stringFa'atupeina ma le le totogiina
total_earned / total_paiddecimal stringLifetime commission maua ma le aofaiga o le olaga totogiina

Faʻatonu, Faʻatonu ma Faʻatupeina

O i latou nei o le a maua i mea uma i le faʻaiuga:

Faʻaiuga Aoga
/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

O le tulaga o le faasino atu o loo faatali, faamalosi po o faasaoina. O le tulaga o le komisi o loo faatali, faatagaina, totogi po o faasaoina. O le tulaga o le totogiina o loo faatali, faagasolo, maea po o le le manuia.

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

Fa'ailoga o Tulaga o Tali

200 Fa'ataunuuina
403 Lelei pe lē talafeagai le tokeni API, po o le tokeni e leai se aia tatau e manaʻomia
404 O lenei teugatupe e le o se fesootaiga

OpenAPI Faʻamatalaga

O le masini-lelei-leai se mea e faitau ai mo so o se endpoint, e aofia ai nei, o le a i lalo, ma e mafai ona e saili i ai i le fesootaiga i luga o le itulau faasinomaga API.

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

Faʻatapulaʻa i le aofaʻi o le teugatupe: 1000 / hour