API tal-Affiliati

Aqra r-rekord affiljat tiegħek, referenzi, kummissjonijiet u ħlasijiet, tibdel l-issettjar tal-ħlas tiegħek u titlob ħlas.Kull punt aħħari jaġixxi fuq il-kont affiljat li għandu t-tokens API.

Punti tat-tmiem 7 endpoints

Mogħdija Bażika /api/v1/affiliates

Punti aħħarin u Skopijiet tat-Token

Oħloq token fil-Kont, imbagħad Developers, u jagħtuha l-iskopijiet l-endpoints hawn taħt bżonn.Kont li mhuwiex affiljat gets 404 minn kull endpoint ħlief signup.

Punt aħħari	Ambitu	Deskrizzjoni
`GET /affiliates/me/`	`affiliates:read`	Ir-rekord affiljat tiegħek, il-bilanċ u l-link ta' referenza
`GET /affiliates/referrals/`	`affiliates:read`	Kontijiet li rreġistraw permezz tal-link tiegħek
`GET /affiliates/commissions/`	`affiliates:read`	Kummissjonijiet miksuba fuq il-pagamenti tar-referenzi tiegħek
`GET /affiliates/payouts/`	`affiliates:read`	Pagamenti mitluba u mħallsa
`PATCH /affiliates/settings/`	`affiliates:update`	Bidla metodu ħlas, PayPal email, Stripe kont jew ammont minimu ħlas `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Talba għall-ħlas tal-bilanċ tiegħek meta jilħaq il-minimu tiegħek. Ħlas pendenti wieħed biss f'daqqa.
`POST /affiliates/signup/`	`affiliates:create`	Ibgħat payout_method (paypal jew strixxa) ma paypal_email jew stripe_account_id.

Il-listi tar-referenzi, kummissjonijiet u ħlasijiet huma paginated: kull tweġiba għandha għadd, li jmiss, preċedenti u r-riżultati.Uża page biex jimxu permezz tagħhom u page_size biex tbiddel kemm oġġetti kull paġna holds.Valuri flus huma rritornati bħala strings deċimali. page_size: 25 (default), 100 (max)

IKSEB /api/v1/affiliates/me/

Ikseb Rekord affiljat tiegħek

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Oqsma ta' Rispons

Qasam	Tip	Deskrizzjoni
`status`	string	pendenti, attiv, sospiż jew terminat. L-affiljati attivi biss jistgħu jitolbu ħlasijiet.
`commission_rate`	decimal string	Kummissjoni bħala perċentwal, mhux frazzjoni `20.00 = 20%`
`cookie_days`	integer	Kemm-il ġurnata klikk fuq il-link tiegħek hija mfakkra
`balance`	decimal string	Akkwistati u għadhom ma tħallsux
`total_earned` / `total_paid`	decimal string	Kummissjoni ta’ ħajja miksuba u ammont ta’ ħajja mħallas

Referenzi, Kummissjonijiet u Ħlasijiet

Kull oġġett fir-riżultati għandu dawn l-oqsma:

Punt aħħari	Qasam
`/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`

L-istatus tar-referenza huwa pendenti, attiv jew ikkanċellat. L-istatus tal-kummissjoni huwa pendenti, approvat, imħallas jew ikkanċellat. L-istatus tal-ħlas huwa pendenti, ipproċessat, komplut jew falla.

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

Kodiċijiet tal-Istatus tar-Rispons

200	Suċċess
403	Token tal-API nieqes jew invalidu, jew it-token ma għandux il-permess meħtieġ
404	Dan il-kont mhuwiex affiljat għadu

Speċifikazzjoni OpenAPI

L-ispeċifikazzjoni li tinqara mill-magni għal kull punt aħħari, inklużi dawn, tinsab hawn taħt, u tista' tibbrawżjaha b'mod interattiv fuq il-paġna ta' referenza tal-API.

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

Limitu tar-rata għal kull kont: 1000 / hour

VPS.org API