Susijusios įmonės API

Skaityti savo filialo įrašą, perduoti, komisiniai ir išmokos, pakeisti savo išmokėjimo nustatymus ir prašyti išmokėjimo. Kiekvienas rezultatas veikia filialo sąskaitą, kuri turi API raktas.

Galutiniai taškai 7 endpoints

Bazinis kelias /api/v1/affiliates

Galutiniai taškai ir žymimos taikymo sritys

Sukurti raktą paskyroje, tada Programuotojai, ir suteikti jai taikymo sritis žemiau reikia. Sąskaita, kuri nėra filialas gauna 404 iš kiekvienos vertinamosios baigties, išskyrus registracijos.

Galutinis taškas	Taikymo sritis	Aprašymas
`GET /affiliates/me/`	`affiliates:read`	Jūsų filialo rekordas, balanso ir kreipimosi nuoroda
`GET /affiliates/referrals/`	`affiliates:read`	Paskyros, kurios pasirašinėjo jūsų nuoroda
`GET /affiliates/commissions/`	`affiliates:read`	Komisijos uždirbo už jūsų kreipimusi į teismą
`GET /affiliates/payouts/`	`affiliates:read`	Prašomos ir sumokėtos išmokos
`PATCH /affiliates/settings/`	`affiliates:update`	Keisti išmokėjimo būdas, PayPal el. paštas, Juosmens paskyra arba minimali išmokėjimo suma `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Paprašyti išmokėti savo balansą, kai jis pasiekia savo minimalią. Tik vienas laukia išmokėti vienu metu.
`POST /affiliates/signup/`	`affiliates:create`	Prisijungti prie filialo programą. Siųsti išmokėjimo_metodą (paypal arba striptiza) su paypal_email arba stripe_account_id.

Perduoti, komisiniai ir išmokos sąrašai yra paginated: kiekvienas atsakymas turi skaičiuoti, toliau, ankstesnis ir rezultatai. Naudokite puslapį, kad pereitumėte per juos ir page_size pakeisti kiek daiktų kiekviename puslapyje turi. Pinigų vertės grąžinamos dešimtainės eilutės. page_size: 25 (default), 100 (max)

GAUTI /api/v1/affiliates/me/

Gauti savo filialo įrašus

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas	Tipas	Aprašymas
`status`	string	laukia, aktyvi, sustabdyta ar nutraukta. Tik aktyvūs filialai gali prašyti išmokėjimo.
`commission_rate`	decimal string	Komisija procentais, o ne dalimi `20.00 = 20%`
`cookie_days`	integer	Kiek dienų paspaudus ant nuorodos, atsimenama
`balance`	decimal string	Išduotas ir dar neišmokėtas
`total_earned` / `total_paid`	decimal string	Uždirbtas komisinis komisinis atlyginimas už visą gyvenimą ir išmokėta suma už visą gyvenimą

Perdavimas, komisijų ir išmokų mokėjimas

Kiekvienas elementas rezultatų yra šios sritys:

Galutinis taškas	Laukas
`/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`

Komisijoje dar laukiama, ji veikia arba atšaukia savo statusą. Komisijoje laukiama, ji yra patvirtinta, išmokėta ar panaikinta.

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

Atsakymo būsenos kodai

200	Sėkmė
403	Trūksta arba netinkamas API žetonas, arba žetonas neturi reikiamo leidimo
404	Ši sąskaita dar nėra filialas

OpenAPI specifikacija

Mašininio nuskaitymo specifika kiekvienai vertinamajai baigčiai, įskaitant ir šias, yra žemiau, ir jūs galite naršyti ją interaktyviai API informaciniame puslapyje.

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

Terminas vienai sąskaitai: 1000 / hour

VPS.org API