Affilante API

Lees jou geafffeerde rekord, verwysings, kommissies en uitbetalings, verander jou verbetalingsinstellings en vra'n betaling uit. Elke punt tree op die gelideerde rekening op wat die API - teken besit.

Eindpunte 7 endpoints

Basispad /api/v1/affiliates

Eindepunte en afknappings

Skep 'n sein in rekening, dan Ontwikkelaars, en gee dit die omvang van die punte hieronder benodig. 'n Rekening wat nie' n geafffilieerde is nie, kry 404 van elke punt, behalwe teken.

Einde punt:	Skoop	Beskrywing
`GET /affiliates/me/`	`affiliates:read`	Jou geakilieerde rekord, balans en verwysingsverbinding
`GET /affiliates/referrals/`	`affiliates:read`	Rekeninge wat deur middel van u skakel onderteken is
`GET /affiliates/commissions/`	`affiliates:read`	Kommissies wat verdien is op julle verwysingsgeld
`GET /affiliates/payouts/`	`affiliates:read`	Voordate wat aangevra en betaal is
`PATCH /affiliates/settings/`	`affiliates:update`	Verander betaaling metode, PathPal e- pos, Lipe rekening of minimum betaal bedrag `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Vra om jou balans te betaal as dit jou minimum bereik.
`POST /affiliates/signup/`	`affiliates:create`	Sluit by die geafffiseerde program aan. Stuur betaling uit_matode (betalings of streep) met betaalopl_email of gelite_accote_id.

Die verwysingsstukke, kommissies en doebesies word gepainteer: elke reaksie het tel, volgende, vorige en resultate. Gebruik bladsy om deur hulle te beweeg en bladsy_grootte om te verander hoeveel items elke bladsy hou. Geldwaardes word as desimale stringe teruggegee. page_size: 25 (default), 100 (max)

KRY /api/v1/affiliates/me/

Kry jou droewige rekord

Voorbeeldversoek

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

Antwoordvelde

Veld	Tipe	Beskrywing
`status`	string	hangende, aktief, hang of beëindig. Slegs aktiewe gelid kan aansoek doen om betaling.
`commission_rate`	decimal string	Kommissie as 'n persentasie, nie 'n fraksie nie `20.00 = 20%`
`cookie_days`	integer	Hoeveel dae 'n kliek op die skakel is onthou
`balance`	decimal string	Oorgeën en nog nie betaal nie
`total_earned` / `total_paid`	decimal string	Lewenstydse opdrag het verdien en lewenslange bedrag is betaal

Met verwysing na die kommissies en die betaling

Elke item wat in resultate gevind word, het hierdie velde:

Einde punt:	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`

Die owerheid se status is hangende, aktief of gekanselleer. Kommissiestatus is hangende, goedgekeur, betaal of gekanselleer.'n Voorlopstatus is hangende, verwerking, voltooi of gefaal.

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

Reaksiestatuskodes

200	Sukses
403	Ontbrekende of ongeldige API-bewys, of die teken het nie die nodige toestemming nie
404	Hierdie rekening is nog nie 'n geaffilieeerde nie

OpenAPI Spesifieke

Die masjien-leesbare spasek vir elke puntpunt, insluitend hierdie, is onder, en jy kan dit interaktief blaai op die API verwysing bladsy.

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

Herhaalde per rekening: 1000 / hour

VPS.org API