Affiliates API

Lees uw affiliate record, verwijzingen, commissies en uitbetalingen, uw uitbetaling instellingen wijzigen en een uitbetaling aanvragen. Elk eindpunt handelt op de affiliate account dat eigenaar is van de API token.

Eindpunten 7 endpoints

Basispad /api/v1/affiliates

Eindpunten en Token scopes

Maak een token aan in Account, vervolgens Ontwikkelaars, en geef het de scopes die de onderstaande eindpunten nodig hebben. Een account dat geen affiliate is krijgt 404 van elk eindpunt behalve aanmelden.

Eindpunt	Toepassingsgebied	Omschrijving
`GET /affiliates/me/`	`affiliates:read`	Uw affiliate record, evenwicht en verwijzing link
`GET /affiliates/referrals/`	`affiliates:read`	Accounts die via uw link zijn aangemeld
`GET /affiliates/commissions/`	`affiliates:read`	Commissies die zijn verdiend op de betalingen van uw doorverwijzingen
`GET /affiliates/payouts/`	`affiliates:read`	Uitbetalingen gevraagd en betaald
`PATCH /affiliates/settings/`	`affiliates:update`	Wijzig uitbetalingsmethode, PayPal e-mail, Stripe-account of minimale uitbetaling bedrag `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Vraag een uitbetaling van uw saldo zodra het uw minimum bereikt. Slechts één lopende uitbetaling per keer.
`POST /affiliates/signup/`	`affiliates:create`	Sluit je aan bij het affiliate programma. Stuur uitbetaling_methode (paypal of stripe) met paypal_email of stripe_account_id.

De verwijzingen, commissies en uitbetalingen lijsten worden gepagineerd: elke reactie heeft tellen, volgende, vorige en resultaten. Gebruik de pagina om te bewegen door hen en page_size om te wijzigen hoeveel items elke pagina bevat. Geld waarden worden geretourneerd als decimale strings. page_size: 25 (default), 100 (max)

KRIJGEN /api/v1/affiliates/me/

Uw account ophalen

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Antwoordvelden

Veld	Type	Omschrijving
`status`	string	in afwachting, actief, opgeschort of beëindigd. Alleen actieve filialen kunnen verzoeken om uitbetalingen.
`commission_rate`	decimal string	Commissie als percentage, geen fractie `20.00 = 20%`
`cookie_days`	integer	Hoeveel dagen een klik op uw link wordt onthouden
`balance`	decimal string	Verdiend en nog niet uitbetaald
`total_earned` / `total_paid`	decimal string	Levenslange commissie verdiend en levenslang uitbetaald bedrag

Verwijzingen, commissies en uitkeringen

Elk item in de resultaten heeft deze velden:

Eindpunt	Veld
`/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 status van verwijzing is in afwachting, actief of geannuleerd. De status van de Commissie is in behandeling, goedgekeurd, betaald of geannuleerd. De uitbetalingsstatus is in afwachting, verwerkt, voltooid of mislukt.

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

Responsstatuscodes

200	Succes
403	Ontbrekende of ongeldige API token, of het token mist de vereiste toestemming
404	Deze account is nog geen affiliate

OpenAPI-specificatie

De machineleesbare spec voor elk eindpunt, inclusief deze, is hieronder, en u kunt er interactief door bladeren op de API referentie pagina.

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

Maximumpercentage per rekening: 1000 / hour

VPS.org API