API e filialëve

Lexo të dhënat e partnerëve, referencat, komisionet dhe pagesat, ndrysho rregullimet e pagesës dhe kërko një pagesë. Çdo pikë përfundimtare vepron në llogarinë e partnerit që zotëron token e API.

Pikat fundore 7 endpoints

Shtegu Bazë /api/v1/affiliates

Pikat e fundit dhe Token Scopes

Krijo një token në Account, pastaj Developers, dhe jepi atij sferat që kanë nevojë pikat përfundimtare më poshtë. Një llogari që nuk është e afërt merr 404 nga çdo pikë përfundimtare përveç regjistrimit.

Pika e fundit	Objektivi	Përshkrimi
`GET /affiliates/me/`	`affiliates:read`	Të dhënat e filialit tënd, balanci dhe lidhjet e referencës
`GET /affiliates/referrals/`	`affiliates:read`	Profilët që janë regjistruar nëpërmjet lidhjes suaj
`GET /affiliates/commissions/`	`affiliates:read`	Komisionet e fituara nga pagesat e referimeve tuaja
`GET /affiliates/payouts/`	`affiliates:read`	Pagimet e kërkuara dhe të paguajë
`PATCH /affiliates/settings/`	`affiliates:update`	Ndrysho metodën e pagesës, email PayPal, llogarinë Stripe ose vlerën minimale të pagesës `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Kërko një pagesë të bilancit tënd kur të arrijë minimumin tënd. Vetëm një pagesë në pritje në një kohë.
`POST /affiliates/signup/`	`affiliates:create`	Bashkohu me programin e afilimit. Dërgo payment_method (paypal ose stripe) me paypal_email ose stripe_account_id.

Listat e referimeve, komisioneve dhe pagesave janë të paginazuara: çdo përgjigje ka numrin, të ardhmen, të kaluarën dhe rezultatet. Përdor page për të lëvizur nëpër to dhe page_size për të ndryshuar numrin e elementëve që çdo faqe mban. Vlerat e parave kthehen si stringa decimale. page_size: 25 (default), 100 (max)

MERR /api/v1/affiliates/me/

Merr rekordin e partnerëve tuaj

Shembull Kërkese

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

Shembull Përgjigjeje

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

Fushat e Përgjigjes

Fusha	Lloji	Përshkrimi
`status`	string	në pritje, aktive, të pezulluara ose të përfunduara. Vetëm partnerët aktivë mund të kërkojnë pagesa.
`commission_rate`	decimal string	Komisioni si përqindje, jo si pjesë `20.00 = 20%`
`cookie_days`	integer	Sa ditë kujtohet klikimi në lidhjen tuaj
`balance`	decimal string	Fituar dhe ende nuk është paguar
`total_earned` / `total_paid`	decimal string	Komision i fituar dhe sasi e paguar

Referime, komisione dhe pagesa

Çdo element në rezultate ka këto fusha:

Pika e fundit	Fusha
`/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`

Gjendja e referencës është në pritje, aktive ose anulluar. Gjendja e komisionit është në pritje, e miratuar, e paguar ose anulluar. Gjendja e pagesës është në pritje, përpunuar, e përfunduar ose dështuar.

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

Kodet e Statusit të Përgjigjes

200	Suksesi
403	Token i munguar apo i pavlefshëm API, ose token nuk ka të drejtat e kërkuara
404	Ky profil nuk është ende një affiliate

Specifikimi OpenAPI

Specifikimi i lexueshme nga makina për çdo pikë përfundimtare, duke përfshirë këto, është më poshtë, dhe ju mund ta shikoni atë interaktivisht në faqen e referencës API.

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

Limiti i normës për llogari: 1000 / hour

VPS.org API