VPS.org API

REST API დოკუმენტაცია

კავშირები

კითხვა თქვენი პარტნიორი ანგარიში, რეფერალური, კომისია და გადახდა, შეცვლის თქვენი გადახდა პარამეტრები და მოთხოვნა გადახდა. ყველა დასასრული მოქმედებს პარტნიორი ანგარიში, რომელიც ფლობს API ტოკენი.

საბოლოო წერტილები 7 endpoints
ბაზისური გზა /api/v1/affiliates

Endpoints and Token Scopes

შექმნა ტოკენი ანგარიშში, შემდეგ განვითარებლებში და მისცე მას ქვემოთ მოცემული დასასრული წერტილების საჭირო არეალი. ანგარიში, რომელიც არ არის კავშირში, მიიღებს 404-ს ყველა დასასრული წერტილიდან, გარდა რეგისტრაციისა.

დასასრული არე აღწერა
GET /affiliates/me/affiliates:readრგჲ£არა ჟჲოჟრგვნჲჟრ, ბალანჟ თ ოპვოჲპჲფვნთვ ლთნთ£ა
GET /affiliates/referrals/affiliates:readანგარიშები, რომლებიც თქვენს ბმულზე დარეგისტრირდა
GET /affiliates/commissions/affiliates:readკჲმთჟთჲნთრვ ჟვ ჱაოჲლჱგარ ჲრ ოლართრვ ნა რგჲთრვ ოპვოჲგვევნთწ.
GET /affiliates/payouts/affiliates:readოჲრპწბგარ თ ჟვ ოჲეაპწრ ოჲლჲზვნთწ.
PATCH /affiliates/settings/affiliates:updateგადახდის მეთოდის შეცვლა, PayPal ელფოსტა, Stripe ანგარიში ან მინიმალური გადახდის თანხა min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createთხოვნა თქვენი ბალანსის გადახდის შესახებ, როდესაც ის მიაღწევს თქვენს მინიმუმს. მხოლოდ ერთი ლოდინი გამორიცხულია ერთდროულად.
POST /affiliates/signup/affiliates:createდაკავშირება პარტნიორულ პროგრამას. გადარიცხვის მეთოდის (paypal ან stripe) გაგზავნა paypal_email ან stripe_account_id- ით.

რეფერატების, კომისიების და გადახდების სია გვერდობრივია: თითოეულ პასუხს აქვს რიცხვი, შემდეგი, წინა და შედეგები. გვერდის გამოყენება მათი გადაადგილებისთვის და გვერდის ზომა გვერდზე არსებული ელემენტების რაოდენობის შესაცვლელად. ფულადი ღირებულებები ათობითი სტრიქონის სახით იგზავნება. page_size: 25 (default), 100 (max)

მიიღეთ /api/v1/affiliates/me/

მიიღეთ თქვენი პარტნიორის ჩანაწერი

მაგალითის მოთხოვნა

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

მაგალითის პასუხი

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

პასუხის ველები

ველი ტიპი აღწერა
statusstringლოდინი, აქტიური, შეჩერებული ან შეწყვეტილი. მხოლოდ აქტიური პარტნიორები შეუძლიათ გადახდის მოთხოვნა.
commission_ratedecimal stringკომისია პროცენტულად, არა ნაწილად 20.00 = 20%
cookie_daysintegerრამდენი დღეა ახსოვს ღილაკი თქვენს ბმულზე
balancedecimal stringჟრპვლწნ თ ჲღვ ნვ თჱოლარვნ
total_earned / total_paiddecimal stringჟრპვლწნთრვ ჟა ჟყჟ ჟრპვლწნთრვ ჟა ჟრპვლწნთ.

რეფერალები, კომისიები და გადასახადები

შედეგების ყველა ელემენტს აქვს შემდეგი ველი:

დასასრული ველი
/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

რეკომენდაციის სტატუსი არის ლოდინი, აქტიური ან გაუქმებული. კომისიის სტატუსი არის ლოდინი, დამოწმებული, გადახდილი ან გაუქმებული. გადახდის სტატუსი არის ლოდინი, დამუშავება, დასრულება ან წარუმატებლობა.

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

პასუხის სტატუსის კოდები

200 წარმატება
403 API ტოკენი არ არის ან არასწორია, ან ტოკენს არ აქვს საჭირო უფლება
404 ეს ანგარიში ჯერ კიდევ არ არის ასოცირებული

OpenAPI განსაზღვრება

1999 წელს გამოვიდა დისკოგრაფია All the Way, რომელიც შეიცავს ყველა დისკოგრაფიას, რომელიც მან გამოუშვა, მათ შორის, The Beatles-ის დისკოგრაფიას.

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

ანგარიშის საზღვარი: 1000 / hour