API-k társtulajdonosai

Olvassa el a partneri rekordot, a referenciákat, jutalékokat és kifizetéseket, változtassa meg a kifizetési beállítások és kérjen kifizetést. Minden végpont az API-token tulajdonában lévő partneri számlán működik.

Végpontok 7 endpoints

Alapút /api/v1/affiliates

Végpontok és célterületek

Hozzon létre egy tokent a Fiókban, majd a Fejlesztők, és adja meg neki a távcső a végpontok alatt szükség. Egy számla, amely nem egy affiliate kap 404 minden végpontot kivéve a regisztráció.

Végpont	Hatály	Leírás
`GET /affiliates/me/`	`affiliates:read`	Az Ön affiliate rekord, egyenleg és áttételi link
`GET /affiliates/referrals/`	`affiliates:read`	A linken keresztül regisztrált számlák
`GET /affiliates/commissions/`	`affiliates:read`	Az Ön felkéréseinek kifizetéséből származó jutalékok
`GET /affiliates/payouts/`	`affiliates:read`	Kérett és kifizetett kifizetések
`PATCH /affiliates/settings/`	`affiliates:update`	A kifizetési mód módosítása, PayPal e-mail, Stripe számla vagy minimális kifizetési összeg `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Kérjen egy összeget, ha eléri a minimumot, csak egy a kifizettetésig.
`POST /affiliates/signup/`	`affiliates:create`	Csatlakozzon az affiliate programhoz. Payout_method (paypal vagy csík) Paypal_email vagy called_account_id.

A beterjesztések, jutalékok és kifizetési listák paginálnak: minden válasznak van száma, következő, előző és eredmény. Oldalt kell mozgatni őket, és oldal_méretet kell megváltoztatni, hogy hány elem minden oldal tartja. Pénz értékek vissza tizedes karakterláncok. page_size: 25 (default), 100 (max)

KAP /api/v1/affiliates/me/

Szerezd meg a társkereső lemezed

Példa kérés

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

Példaválasz

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

Válaszmezők

Mező	Típus	Leírás
`status`	string	függőben lévő, aktív, felfüggesztett vagy megszüntetett. Csak aktív leányvállalatok kérhetnek kifizetést.
`commission_rate`	decimal string	A Bizottság mint százalék, nem pedig egy töredék `20.00 = 20%`
`cookie_days`	integer	Hány nap kattintás a linkre emlékeznek
`balance`	decimal string	Kiérdemelt és még ki nem fizetett
`total_earned` / `total_paid`	decimal string	Élettartam-díj és az élethosszig tartó fizetett összeg

Ajánlások, bizottságok és kifizetések

Minden tétel az eredmények ezek a mezők:

Végpont	Mező
`/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`

A beutalási státusz függőben van, aktív vagy törölt. A Bizottság státusza függőben van, jóváhagyott, kifizetett vagy törölt. A kifizetés státusza folyamatban van, feldolgozás, befejezett vagy sikertelen.

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

Válasz állapotkódok

200	Siker
403	Hiányzó vagy érvénytelen API token, vagy a token hiányzik a szükséges engedély
404	Ez a számla még nem társult tag

OpenAPI specifikáció

A gépileg olvasható specifikáció minden végpontra, beleértve ezeket is, az alábbiakban található, és interaktívan böngészhet az API referenciaoldalán.

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

Számlaenkénti kamatlábhatár: 1000 / hour

VPS.org API