Affiliates API

Əlaqə qeydlərinizi, tövsiyyələri, komissiyaları və ödənişləri oxuyun, ödəniş qurğularınızı dəyişdirin və ödəniş istəyin. Hər son nöqtəsi API tokeninə sahib olan ödəniş hesabınızda işləyir.

Son Nöqtələr 7 endpoints

Əsas Yol /api/v1/affiliates

Son nöqtələr və Token sahələri

Hesab, sonra İnkişaf etdiricilər bölməsində bir token yaradın və aşağıda göstərilən son nöqtələrin ehtiyac duyduğu sahələri ona verin. Əlaqəsiz hesab qeydiyyatdan başqa hər son nöqtədən 404 alır.

Son nöqtəsi	Əlavə Et	İzahat
`GET /affiliates/me/`	`affiliates:read`	Sizin affiliate rekordunuz, balans və tövsiyyə bağlantınız
`GET /affiliates/referrals/`	`affiliates:read`	Körpünüz vasitəsilə qeyd olunan hesablar
`GET /affiliates/commissions/`	`affiliates:read`	Təqdim etdiyiniz ödənişlər üzrə qazandığınız komissiyalar
`GET /affiliates/payouts/`	`affiliates:read`	İstənilən və ödənilmiş ödənişlər
`PATCH /affiliates/settings/`	`affiliates:update`	Ödəniş metodu, PayPal e-poçtu, Stripe hesabı və ya minimum ödəniş məbləğini dəyişdir `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Minimuma çatanda balansınızın ödənilməsini xahiş edin. Bir anda yalnız bir ödəniş gözlənilir.
`POST /affiliates/signup/`	`affiliates:create`	Əlaqə proqramına qoşulun. payment_method (paypal ya da stripe) ilə paypal_email ya da stripe_account_id göndərin.

Referanslar, komissiyalar və ödənişlər siyahıları səhifələnir: hər cavab say, sonrakı, əvvəlki və nəticələr daşıyır. Onları keçmək üçün page və hər səhifədə nə qədər elementin olduğunu dəyişmək üçün page_size istifadə et. Pul dəyərləri onluq string olaraq geri qaytarılır. page_size: 25 (default), 100 (max)

AL /api/v1/affiliates/me/

Affiliate Record

Nümunə Sorğu

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

Nümunə Cavab

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

Cavab Sahələri

Sahə	Növü	İzahat
`status`	string	gözlənilir, aktiv, dayandırılır ya da bitmişdir. Yalnız aktiv tərəfdaşların ödəniş istəməsi mümkündür.
`commission_rate`	decimal string	Komisiya faizi, kəsr deyil `20.00 = 20%`
`cookie_days`	integer	Körpünüzdəki klikin nə qədər gün yadda saxlanacağı
`balance`	decimal string	Əlavə et
`total_earned` / `total_paid`	decimal string	Ömür boyu qazanılmış komissiya və ömür boyu ödənilmiş məbləğ

Referrals, Commissions and Payouts

Nəticələrdəki hər bir element bu sahələrdən ibarətdir:

Son nöqtəsi	Sahə
`/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`

Referal vəziyyəti gözlənilir, aktivdir ya da ləğv edilmişdir. Komissiya vəziyyəti gözlənilir, təsdiqlənir, ödənilir ya da ləğv edilir. Ödəniş vəziyyəti gözlənilir, işlənir, tamamlanır ya da bacarılmır.

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

Cavab Status Kodları

200	Müvəffəqiyyət
403	API tokeni yoxdu ya da səhvdir, ya da tokenin lazımi icazəsi yoxdur
404	Bu hesab hələlik bir affiliate deyil

OpenAPI Təsvir

Bular da daxil olmaqla hər bir son nöqtəyə aid olan maşın oxuna bilən spesifikasiya aşağıdadır və API istinad səhifəsində interaktiv olaraq axtarıla bilər.

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

Hesab üçün faiz həddi: 1000 / hour

VPS.org API