API

Vakio ny tahirin-kevitrao momba ny mpiara-miasa, ny fampidirana, ny komisiona ary ny fandoavanao, ovao ny fandrindranao ny fandoavanao ary mangataka fandoavanao. Miasa amin'ny kaonty mpiara-miasa manana ny token API ny endpoint tsirairay.

Teboka farany 7 endpoints

Lalana fototra /api/v1/affiliates

Endpoints sy Token Scopes

Hamorona token ao amin'ny Account, dia avy eo Developers, ary omeo ny elanelam-potoana ilain'ny endpoints eto ambany. Ny kaonty tsy mpikambana dia mahazo 404 avy amin'ny endpoints rehetra afa-tsy ny fidirana.

Endpoint	Fandraisana an-tànana	Fanoritsoritana
`GET /affiliates/me/`	`affiliates:read`	Ny tantaran'ny mpiara-miasa aminao, ny saldo ary ny rohy fampidirana
`GET /affiliates/referrals/`	`affiliates:read`	Kaonty izay nisoratra anarana tamin'ny alalan'ny rohinao
`GET /affiliates/commissions/`	`affiliates:read`	Ny komisiona azo amin'ny fandoavana ny fampidiranao
`GET /affiliates/payouts/`	`affiliates:read`	Fandoavana vola nangatahana sy nandoavana
`PATCH /affiliates/settings/`	`affiliates:update`	Manova ny fomba fandoavam-bola, mailaka PayPal, kaonty Stripe na ny sanda ambany indrindra amin'ny fandoavam-bola `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Mangataka ny hamoahana ny trosao rehefa tonga amin'ny fetra ambany indrindra izy. Fandoavana iray ihany no miandry isaky ny fotoana.
`POST /affiliates/signup/`	`affiliates:create`	Miditra amin'ny fandaharam-piaraha-miasa. Mandefa ny fomba_fividianana (paypal na stripe) miaraka amin'ny paypal_email na stripe_account_id.

Mizara pejy ny lisitr'ireo fampidirana, ny komisiona ary ny fandoavam-bola: manana isa, manaraka, teo aloha ary vokany ny valinteny tsirairay. Ampiasao ny page hitetezana azy ireo ary ny page_size hanova ny isan'ny zavatra ahitana ny pejy tsirairay. Averina amin'ny endri-daha-daza ny sanda ara-bola. page_size: 25 (default), 100 (max)

ALAO /api/v1/affiliates/me/

Maka ny tahirin-kevitrao

Ohatra amin'ny fangatahana

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

Ohatra amin'ny Valiny

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

Saha Valiny

Field	Karazana	Fanoritsoritana
`status`	string	miandry, miasa, naato na naato. Ireo mpiara-miasa miasa ihany no afaka mangataka ny fandoavana.
`commission_rate`	decimal string	Ny komisiona amin'ny isan-jato, fa tsy ampahany `20.00 = 20%`
`cookie_days`	integer	Isan'ny andro ankalazana ny kitendrin'ny rohy
`balance`	decimal string	Voasoratra ary mbola tsy voaloa
`total_earned` / `total_paid`	decimal string	Fifanarahana mandritra ny fiainana azo sy ny vola azo mandritra ny fiainana

Fampidirana, Vaomiera sy Fandoavana

Manana ireto sehatra ireto ny zavatra tsirairay ao amin'ny valin'ny fikarohana:

Endpoint	Field
`/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`

Miandry, miasa na nofoanana ny toetran'ny fampidirana. Miandry, nankatoavina, nandoa na nofoanana ny toetran'ny komisiona. Miandry, nahavita na tsy nahomby ny toetran'ny fandoavana.

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

Kaody momba ny satan'ny valiny

200	Fahombiazana
403	Token API tsy misy na tsy mitombina, na tsy manana ny fahazoan-dàlana ilaina ilay token
404	Tsy mbola mpikambana ity kaonty ity

Famaritana OpenAPI

Ny soratra dia azo adika amin'ny alalan'ny fiteny rehetra, ary ny soratra dia azo adika amin'ny alalan'ny fiteny rehetra.

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

Fetra amin'ny tahan'ny isan-kaonty: 1000 / hour

VPS.org API

API