VPS.org API

REST API Documentation

Affiliates API

Pangani akaunti yanu ya affiliate, gwiritsani ntchito ma adilesi anu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu, gwiritsani ntchito ndalama zanu.

Mapeto 7 endpoints
Njira Yoyambira /api/v1/affiliates

Endpoints ndi Token Scopes

Kukhazikitsa token mu akaunti, ndiye Developers, ndi kupatsa izo zolinga zofunikira pansipa. akaunti kuti si affiliate amalandira 404 kuchokera pa zonse endpoints kupatula signup.

Chithunzi Kuthamanga Kufotokozera
GET /affiliates/me/affiliates:readKugwirizana kwanu, malire anu ndi kulumikizana kwa kulumikizana
GET /affiliates/referrals/affiliates:readMaakaunti omwe adalembetsa pogwiritsa ntchito chingwe chanu
GET /affiliates/commissions/affiliates:readMakomishoni ochokera pa malipiro a oyang'anira anu
GET /affiliates/payouts/affiliates:readMavuto ofunsidwa ndi olipira
PATCH /affiliates/settings/affiliates:updateSinthani njira yolipira, imelo ya PayPal, akaunti ya Stripe kapena ndalama zosakwanira min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createKupempha ndalama ya akaunti yanu pamene ifika mlingo wanu wazochepa. Chokha chimodzi choyembekezera ndalama pa nthawi.
POST /affiliates/signup/affiliates:createKugwirizana ndi affiliate pulogalamu. Kutumiza payout_method (paypal kapena stripe) ndi paypal_email kapena stripe_account_id.

Malamulo, mabungwe ndi ndalama zolipira mnda ndi paginated: chilichonse yankho ali mfundo, Next, Previous ndi zotsatira. Kugwiritsa ntchito page kupita mwa iwo ndi page_size kusintha zinthu zingati patsamba lina ali. ndalama mfundo ndi kubwezeredwa monga decimal strings. page_size: 25 (default), 100 (max)

Pezani /api/v1/affiliates/me/

Pezani Affiliate Record yanu

Chitsanzo cha Pempho

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

Chitsanzo cha Yankho

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

Mayankho a Minda

Kuwala Mtundu Kufotokozera
statusstringKutumiza kwa ndalama kumatha kukhala kosalekeza, kogwira ntchito, kolephera kapena kothamanga.
commission_ratedecimal stringCommission monga peresenti, si mbali 20.00 = 20%
cookie_daysintegerKodi masiku angati aklikidwa patsamba lanu ndipo amakumbukira
balancedecimal stringKupeza ndi sipokha analipira
total_earned / total_paiddecimal stringM'moyo wa komisiyo analandira ndi moyo ndalama analipira

Kutumiza, Commissions ndi Payouts

Gawo lililonse mu zotsatira ali ndi madera awa:

Chithunzi Kuwala
/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

Mtundu wa akaunti ndi wopanda malire, wogwira ntchito kapena wolephera. Mtundu wa akaunti ndi wopanda malire, wovomerezeka, wolipira kapena wolephera. Mtundu wa akaunti ndi wopanda malire, wopanga, womaliza kapena wolephera.

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

Makhodi a Mkhalidwe Woyankha

200 Kupambana
403 Kukayika kapena ayi API token, kapena token alibe zofunika chilolezo
404 Izi akaunti si affiliatebe

OpenAPI Specification

Makinawa owerenga makina a spec kwa aliyense endpoint, kuphatikizapo izi, ndi pansipa, ndipo mutha kuyika patsamba la API reference.

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

Kusinthanitsa kwa ndalama paakaunti: 1000 / hour