Affiliates API

Jo affiliate- rekord, ferwizings, kommisjes en útjeften lêze, jo útjefte- ynstellings feroarje en in útjefte oanfreegje. Elk einpunt wurket op it affiliate- akkount dat de API- token besit.

Einpunten 7 endpoints

Basispaad /api/v1/affiliates

Einpunten en tokens

Meitsje in token oan yn Account, dan Developers, en jou it de omfang dy' t de einpunten hjirûnder nedich binne. In akkount dat net in affiliate is krijt 404 fan elk einpunt behalve oanmelden.

Einpunt	Berik	Beskriuwing
`GET /affiliates/me/`	`affiliates:read`	Jo affiliate rekord, saldo en ferwiislink
`GET /affiliates/referrals/`	`affiliates:read`	Akkounts dy't oanmeld binne fia jo keppeling
`GET /affiliates/commissions/`	`affiliates:read`	Provizje fertsjinne op jo ferwizingen
`GET /affiliates/payouts/`	`affiliates:read`	Utjeften fersochte en betelle
`PATCH /affiliates/settings/`	`affiliates:update`	Wizigje de útbetellingsmethode, PayPal e- mail, Stripe akkount of minimum útbetellingsbedrach `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Freegje om in útkearing fan jo saldo as it jo minimum berikt. Allinne ien útkearing yn ôfwachting op in kear.
`POST /affiliates/signup/`	`affiliates:create`	Meidwaan oan it affiliate programma. Sjoch payout_method (paypal of stripe) mei paypal_email of stripe_account_id.

De list mei ferwizings, kommisjes en útjeften is op pagina' s ferdield: elke antwurd hat in oantal, folgjende, foarige en resultaten. Brûk page om troch te gean en page_ size om te feroarjen hoefolle items elke side hat. De jildwearden wurde weromjûn as desimale tekenriges. page_size: 25 (default), 100 (max)

KRIJE /api/v1/affiliates/me/

Jou jo affiliate rekord op

Foarbyldfersyk

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

Foarbyldantwurd

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

Antwurdfjilden

Fjild	Type	Beskriuwing
`status`	string	yn behanneling, aktyf, opslein of beëinige. Allinne aktive partners kinne útjeften oanfreegje.
`commission_rate`	decimal string	Kommisje as persintaazje, net as breuk `20.00 = 20%`
`cookie_days`	integer	Hoefolle dagen in klik op jo keppeling ûnthâlden wurdt
`balance`	decimal string	Earst
`total_earned` / `total_paid`	decimal string	Lifetime commission earned and lifetime amount paid out

Ferwizings, kommisjes en útjeften

Elk item yn de resultaten hat dizze fjilden:

Einpunt	Fjild
`/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`

De ferwiisstatus is wachtsjend, aktyf of annulearre. De kommisjestatus is wachtsjend, goedkard, betelle of annulearre. De útkearingsstatus is wachtsjend, ferwurke, foltôge of mislearre.

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

Antwurdstatuskoades

200	Suksesfol
403	Untbrekkend of ûnjildich API-token, of it token hat net de fereaske tagongsrjochten
404	Dit akkount is noch net in affiliate

OpenAPI Spesifikaasje

De masineleesbere spesifikaasje foar elk einpunt, mei dy hjirûnder, is hjirûnder te finen, en jo kinne it ynteraktyf besjen op de API-referinsjeside.

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

Frekwinsjelimyt per akkount: 1000 / hour

VPS.org API