برنامج التطبيقات المتقدمة

قراءة سجلاتك التابعة، والإحالات، والعمولات والمدفوعات، وتغيير إعدادات المدفوعات وطلب دفع. كل نقطة نهاية تعمل على حساب التابعة التي تمتلك رمز API.

نقاط النهاية 7 endpoints

المسار الأساسي /api/v1/affiliates

نقاط النهاية ونطاقات الرموز

إنشاء رمز في حساب، ثم المطورين، وإعطاءها الأقاليم النقاط النهائية أدناه تحتاج. حساب الذي ليس منتسبا يحصل 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 للتنقل بينها و 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"
}

حقول الاستجابة

الميدان	يكتب	وصف المشروع
`status`	string	لا يمكن إلا للمنتسبين النشطين طلب الدفعات.
`commission_rate`	decimal string	العمولة كنسبة مئوية، وليس كجزء من قيمة العقد `20.00 = 20%`
`cookie_days`	integer	كم عدد الأيام التي يتم فيها تذكر النقر على رابطك
`balance`	decimal string	مستحقة ولم تدفع بعد
`total_earned` / `total_paid`	decimal 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

ويرد أدناه الموصفات المقروءة آلياً لكل نقطة نهائية، بما في ذلك هذه، ويمكنك تصفحها تفاعلياً على الصفحة المرجعية لبرنامج الوصلة البينية.

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

الحد الأقصى للمعدل لكل حساب: 1000 / hour

VPS.org API