Saistītie uzņēmumi API

Izlasiet savu filiāles ierakstu, liecības, komisijas un izmaksas, mainīt jūsu izmaksu iestatījumus un pieprasīt izmaksu. Katrs mērķa kritērijs darbojas uz filiāles kontā, kas pieder API žetonu.

Galapunkti 7 endpoints

Bāzes ceļš /api/v1/affiliates

Mērķa punkti un simboli

Izveidot žetonu kontā, tad izstrādātāji, un sniegt tai darbības jomu zemāk mērķapjomi nepieciešams. Konts, kas nav filiāle saņem 404 no katra mērķapjoma, izņemot reģistrāciju.

Mērķa punkts	Darbības joma	Apraksts
`GET /affiliates/me/`	`affiliates:read`	Jūsu filiāles rekords, līdzsvars un pieprasījuma saiti
`GET /affiliates/referrals/`	`affiliates:read`	Konti, kas parakstījušies caur jūsu saiti
`GET /affiliates/commissions/`	`affiliates:read`	Komisijas ienākumi no jūsu pieprasījumiem
`GET /affiliates/payouts/`	`affiliates:read`	Pieprasītie un samaksātie maksājumi
`PATCH /affiliates/settings/`	`affiliates:update`	Mainīt izmaksu metodi, PayPal e-pasts, Stripe konts vai minimālā izmaksāšanas summa `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Pieprasījums izmaksu savu atlikumu, kad tas sasniedz savu minimumu. Tikai viens vēl izmaksāšanu laikā.
`POST /affiliates/signup/`	`affiliates:create`	Pievienojies filiāles programmā. Sūtīt payout_method (paypal vai stripe) ar paypal_email vai stripe_account_id.

Pārsūtījumu, komisijas un izmaksu saraksti ir paginated: katra atbilde ir skaitījis, nākamais, iepriekšējo un rezultāti. Izmanto lapu, lai pārvietotos caur tiem un page_size, lai mainītu cik vienību katrā lapā tur. Naudas vērtības tiek atgrieztas kā decimāldaļas. page_size: 25 (default), 100 (max)

IEGŪT /api/v1/affiliates/me/

Iegūstiet sava filiāles ierakstu

Pieprasījuma piemērs

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

Atbildes piemērs

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

Atbildes lauki

Lauks	Tips	Apraksts
`status`	string	gaidāmais, aktīvais, apturētais vai izbeigtais. Tikai aktīvie saistītie var pieprasīt izmaksu.
`commission_rate`	decimal string	Komisija procentos, nevis daļā `20.00 = 20%`
`cookie_days`	integer	Cik dienas klikšķis uz jūsu saites ir atcerējies
`balance`	decimal string	Izsniegts un vēl nav izmaksāts
`total_earned` / `total_paid`	decimal string	Nopelnītās komisijas naudas un samaksātā summa par mūžu

Nosūtīšana, komisijas un izmaksas

Katrs postenis rezultātu ir šīs jomas:

Mērķa punkts	Lauks
`/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`

Vēl nav saņemts, tas ir aktīvs vai atcelts. Komisijas statuss vēl nav apstiprināts, apmaksāts vai atcelts. Vēl nav nokārtots, apstrādāts, pabeigts vai nav izgājis.

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

Atbildes statusa kodi

200	Panākumi
403	Trūkst vai nav spēkā API žetons, vai žetonam trūkst nepieciešamās atļaujas
404	Šis konts vēl nav saistīts

OpenAPI specifikācija

Mašīnlasāmā specifikācija katram galapunktam, ieskaitot tos, ir zemāk, un jūs varat to pārlūkot interaktīvi API atsauces lapā.

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

Likmes ierobežojums kontā: 1000 / hour

VPS.org API