API وابستگان

خواندن رکورد وابسته خود، ارجاعات، کمیسیون و پرداخت‌ها، تغییر تنظیمات پرداخت خود و درخواست پرداخت. هر نقطه پایانی بر روی حساب وابسته که مالک نشان API است عمل می‌کند.

نقاط پایانی 7 endpoints

مسیر پایه /api/v1/affiliates

نقطه پایانی و محدوده نشانه

یک نشانه در حساب، سپس توسعه دهندگان ایجاد کنید و به آن محدوده‌هایی که نقطه پایانی زیر نیاز دارد را بدهید. یک حساب که وابسته نیست از هر نقطه پایانی به جز ثبت نام 404 دریافت می‌کند.

نقطه پایانی	محدوده	Description
`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 برای حرکت در میان آنها و page_size برای تغییر تعداد عناصری که هر صفحه دارد استفاده کنید. مقادیر پول به عنوان رشته‌های اعشاری بازگردانده می‌شوند. 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"
}

فیلدهای پاسخ

میدان	نوع	Description
`status`	string	منتظر، فعال، معلق یا پایان یافته. فقط وابستگان فعال می‌توانند درخواست پرداخت کنند.
`commission_rate`	decimal string	کمیسیون به صورت درصد، نه کسر `20.00 = 20%`
`cookie_days`	integer	چند روز یک کلیک بر روی پیوند شما به یاد می‌آید
`balance`	decimal string	بدست آمده و هنوز پرداخت نشده
`total_earned` / `total_paid`	decimal string	Lifetime commission earned and lifetime amount paid out

.

هر مورد در نتایج این دامنه ها را دارد:

نقطه پایانی	میدان
`/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

مشخصات قابل خواندن ماشین برای هر نقطه پایانی، از جمله این‌ها، در زیر آمده است و می‌توانید آن را به صورت تعاملی در صفحه مرجع API جستجو کنید.

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

محدودیت نرخ برای هر حساب: 1000 / hour

VPS.org API