Sidusrühmade API

Loe oma siduskonto rekord, esildised, vahendustasud ja väljamaksed, muuta oma väljamakse seaded ja taotleda väljamakse. Iga tulemusnäitaja toimib affiliate konto, mis omab API märgi.

Lõpp-punktid 7 endpoints

Baasrada /api/v1/affiliates

Tulemuspunktid ja märgi ulatus

Loo konto, siis Arendajad, ja anna sellele ulatus tulemusnäitajad allpool vaja. Konto, mis ei ole seotud saab 404 igast tulemusnäitajast välja arvatud signup.

Tulemusnäitaja	Reguleerimisala	Description
`GET /affiliates/me/`	`affiliates:read`	Teie sidusandmete, bilansi ja saatekirja link
`GET /affiliates/referrals/`	`affiliates:read`	Kontod, mis on sinu lingi kaudu registreeritud
`GET /affiliates/commissions/`	`affiliates:read`	Komisjonitasud teie konsulteerimistaotlustega seotud maksete eest
`GET /affiliates/payouts/`	`affiliates:read`	Taotletud ja makstud väljamaksed
`PATCH /affiliates/settings/`	`affiliates:update`	Muuda väljamakse meetod, PayPal e-posti, Stripe konto või minimaalne väljamakse summa `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Kui see on miinimumi jõudnud, küsige oma tasakaalu väljamaksmist, ainult üks makse üks kord.
`POST /affiliates/signup/`	`affiliates:create`	Liituge partnerprogrammiga. Saada väljamakse_ meetod (paypal või triip) paypal_ email või triip_ account_id.

Saatmised, komisjonitasud ja väljamaksete nimekirjad on nummerdatud: iga vastus on loendunud, järgmine, eelmine ja tulemused. Kasuta lehte liikuda läbi nende ja lehekülje_ suurus muuta, kui palju elemente iga lehekülg omab. Raha väärtused tagastatakse kümnendikstringid. page_size: 25 (default), 100 (max)

SAA /api/v1/affiliates/me/

Hangi oma sidusandmed

Näidistaotlus

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

Näidisvastus

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

Vastuseväljad

Väli	Tüüp	Description
`status`	string	ootel, aktiivne, peatatud või lõpetatud. Ainult aktiivsed sidusettevõtted saavad nõuda väljamakseid.
`commission_rate`	decimal string	Komisjon protsendina, mitte murdosana `20.00 = 20%`
`cookie_days`	integer	Mitu päeva klõps oma linki mäletatakse
`balance`	decimal string	Teenitud ja veel maksmata
`total_earned` / `total_paid`	decimal string	Teenitud eluaegse komisjonitasu ja väljamakstud eluaegse summa

Esildised, komisjonitasud ja väljamaksed

Tulemuste iga kirje väljad:

Tulemusnäitaja	Väli
`/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`

Esildis on pooleli, aktiivne või tühistatud. Komisjoni staatus on pooleli, heaks kiidetud, makstud või tühistatud. Väljamaksmine on pooleli, töötlemine, lõpetatud või nurjus.

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

Vastuse olekukoodid

200	Edukas
403	Puuduv või vigane API märgis või märgil puudub nõutav luba
404	See konto ei ole veel seotud

OpenAPI spetsifikatsioon

Masinloetav spetsifikatsioon iga tulemusnäitaja kohta, sealhulgas need, on allpool ja seda saab interaktiivselt sirvida API viiteleheküljel.

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

Hinnapiirang konto kohta: 1000 / hour

VPS.org API