VPS.org API

REST API belgelendirmesi

Affiliates API

Affiliate kayıtlarınızı, referansları, komisyonları ve ödemeleri okuyun, ödeme ayarlarınızı değiştirin ve ödeme isteyin. Her son nokta API tokenine sahip olan affiliate hesabı üzerinde hareket eder.

Uç noktalar 7 endpoints
Temel Yol /api/v1/affiliates

Son noktalar ve token alanları

Hesap, sonra Geliştiriciler'de bir token oluşturun ve aşağıda belirtilen son noktaların ihtiyacı olan alanları verin. Bir üye olmayan bir hesap, kayıt dışında her son noktadan 404 alır.

Son nokta Alan Açıklama
GET /affiliates/me/affiliates:readAffiliate kayıtlarınız, balansınız ve referans linkiniz
GET /affiliates/referrals/affiliates:readLinkiniz üzerinden kayıtlı hesaplar
GET /affiliates/commissions/affiliates:readRehberlerinizin ödemelerinden kazandığınız komisyonlar
GET /affiliates/payouts/affiliates:readÖdeme talep edildi ve ödendi
PATCH /affiliates/settings/affiliates:updateÖdeme yöntemini, PayPal e-posta adresini, Stripe hesabı veya minimum ödeme miktarını değiştir min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createMinimuma ulaştığında, hesabınızdan bir ödeme isteyin. Bir seferde sadece bir bekleyen ödeme.
POST /affiliates/signup/affiliates:createAffiliate programına katılın. Payout_method (paypal veya stripe) ile paypal_email veya stripe_account_id gönderin.

Referanslar, komisyonlar ve ödemeler listeleri sayfalı olarak gösterilir: her cevap sayı, sonraki, önceki ve sonuçlar içerir. Aralarında gezinmek için page'ı kullanın ve sayfanın ne kadar madde içerdiğini değiştirmek için page_size'ı kullanın. Para değerleri ondalık diziler olarak geri döndürülür. page_size: 25 (default), 100 (max)

ELDE ETMEK /api/v1/affiliates/me/

Affiliate kayıtınızı alın

Örnek Talep

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

Örnek Yanıt

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

Yanıt Alanları

Alan Tip Açıklama
statusstringBekleyen, aktif, askıya alınmış veya sona ermiş. Sadece aktif ortaklar ödeme talep edebilir.
commission_ratedecimal stringKomisyon yüzde olarak, parçacık değil 20.00 = 20%
cookie_daysintegerLinkinize tıkladığınızda kaç gün hatırlanacağı
balancedecimal stringKazanılmış ve henüz ödenmemiş
total_earned / total_paiddecimal stringHayat boyu komisyon kazanıldı ve hayat boyu para ödendi.

Referanslar, Komisyonlar ve Ödemeler

Sonuçlarda her bir madde şu alanlara sahiptir:

Son nokta Alan
/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

Referans durumunu bekleyen, aktif veya iptal edilmiş. Komisyon durumunu bekleyen, onaylanmış, ödenmiş veya iptal edilmiş. Ödeme durumunu bekleyen, işleme alınmış, tamamlanmış veya başarısız.

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

Yanıt Durum Kodları

200 Başarı
403 Eksik veya geçersiz API token'ı, ya da token'ın gerekli izinleri yok
404 Bu hesap henüz bir affiliate değil

OpenAPI Özelliği

Bunlar da dahil olmak üzere her son nokta için makine okunabilir spesifikasyon aşağıdadır ve API referans sayfasında etkileşimli olarak gezinebilirsiniz.

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

Hesap başına hız sınırı: 1000 / hour