Afiliate API

Citiți recordul afiliat, trimiterile, comisioanele și plățile, schimbați setările de plată și solicitați o plată. Fiecare punct de end acționează pe contul afiliat care deține token API.

Puncte finale 7 endpoints

Calea de bază /api/v1/affiliates

Puncte finale și domenii de aplicare

Creați un token în Cont, apoi Dezvoltatori, și să-i dau domeniul de aplicare punctele finale de mai jos nevoie. Un cont care nu este un afiliat obține 404 de la fiecare punct final, cu excepția înregistrării.

Punctul final	Domeniul de aplicare	Descriere
`GET /affiliates/me/`	`affiliates:read`	Înregistrarea, echilibrul și linkul de referință al afiliatului
`GET /affiliates/referrals/`	`affiliates:read`	Conturile care s-au înscris prin link-ul dvs.
`GET /affiliates/commissions/`	`affiliates:read`	Comisia câştigă în cazul plăţilor de referinţă
`GET /affiliates/payouts/`	`affiliates:read`	Plăți solicitate și plătite
`PATCH /affiliates/settings/`	`affiliates:update`	Schimbare metoda de plată, e-mail PayPal, cont Stripe sau valoarea minimă de plată `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Solicită o plată a soldului tău o dată când ajunge la minimul tău, doar o plată pe rând.
`POST /affiliates/signup/`	`affiliates:create`	Alăturați-vă la programul afiliat. Trimite-vă payout_metode (paypal sau stripe) cu paypal_email sau stripe_account_id.

Lista de trimiteri, comisii și payouts sunt paginate: fiecare răspuns are număr, următor, precedent și rezultate. Folosește pagina pentru a trece prin ele și pagina_size pentru a schimba câte elemente deține fiecare pagină. Valorile banilor sunt returnate ca senduri decimale. page_size: 25 (default), 100 (max)

OBŢINE /api/v1/affiliates/me/

Ia-ţi înregistrarea afiliaţilor

Exemplu de solicitare

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

Exemplu de răspuns

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

Câmpuri de răspuns

Câmp	Tip	Descriere
`status`	string	în cursul perioadei de tranziție, în suspensie sau încheiat. Doar afiliații active pot solicita plăți.
`commission_rate`	decimal string	Comisia ca procent, nu ca o fracție `20.00 = 20%`
`cookie_days`	integer	Câte zile se amintește un clic pe link
`balance`	decimal string	Apăsată și încă nepagată
`total_earned` / `total_paid`	decimal string	Comisioane de viață câștigate și valoarea de viață plătită

Referințe, comisii și plate

Fiecare element în rezultate are aceste domenii:

Punctul final	Câmp
`/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`

Starea de referință este în așteptare, activă sau anulată. Starea Comisiei este în așteptare, aprobată, plătită sau anulată. Starea de plată este în așteptare, prelucrare, completare sau eșuat.

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

Coduri de stare a răspunsului

200	Succes
403	Token API lipsă sau nu este valid, sau tokenul nu este permisul necesar
404	Acest cont nu este încă o afiliată

Specificație OpenAPI

Specificația de citire a mașinii pentru fiecare punct de vedere final, inclusiv acestea, este mai jos, și puteți naviga interactiv pe pagina de referință API.

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

Limita de rată per cont: 1000 / hour

VPS.org API