VPS.org API

REST API ডকুমেন্টেশন

সংশ্লিষ্ট API

আপনার অ্যাফিলিয়েট রেকর্ড, রেফারেন্স, কমিশন এবং পেমেন্ট পড়ুন, আপনার পেমেন্ট সেটিংস পরিবর্তন করুন এবং পেমেন্টের অনুরোধ করুন। প্রত্যেক এনডপয়েন্ট অ্যাফিলিয়েট অ্যাকাউন্টে কাজ করে যা API টোকেন এর মালিক।

শেষবিন্দু 7 endpoints
বেস পাথ /api/v1/affiliates

এনডোমেন্ট এবং টোকেন স্কোপ

অ্যাকাউন্ট, তারপর ডেভেলপার-এ একটি টোকেন তৈরি করুন এবং নিম্নলিখিত এনডপয়েন্টের প্রয়োজনীয় পরিধি প্রদান করুন। একটি অ্যাকাউন্ট যা একটি অ্যাফিলিয়েট নয়, তা সাবস্ক্রাইব ব্যতীত প্রত্যেক এনডপয়েন্ট থেকে ৪০৪ পাবে।

শেষ বিন্দু পরিধি বর্ণনা
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পরিশোধের পদ্ধতি, পেপাল ই-মেইল, স্ট্রিপ অ্যাকাউন্ট বা সর্বনিম্ন পরিশোধের পরিমাণ পরিবর্তন করুন min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createআপনার ভারসাম্য যখন আপনার ন্যূনতম পরিমাণে পৌঁছে যায় তখন আপনার ভারসাম্য থেকে একটি পেমেন্টের অনুরোধ করুন। একই সময়ে শুধুমাত্র একটি পেমেন্টের জন্য অপেক্ষা করুন।
POST /affiliates/signup/affiliates:createএফিলিয়েট প্রোগ্রামে যোগ দিন। paypal_email অথবা stripe_account_id সহ payment_method (paypal অথবা stripe) পাঠান।

রেফারেন্স, কমিশন এবং পেমেন্ট তালিকা পৃষ্ঠাভুক্ত করা হয়েছে: প্রতিটি উত্তরে সংখ্যা, পরবর্তী, পূর্ববর্তী এবং ফলাফল রয়েছে। এগুলোর মধ্যে সরে যাওয়ার জন্য page ব্যবহার করুন এবং page_size ব্যবহার করে প্রতিটি পৃষ্ঠাতে কতগুলো বস্তু আছে তা পরিবর্তন করুন। অর্থের মান দশমিক স্ট্রিং হিসাবে ফিরিয়ে দেওয়া হয়। page_size: 25 (default), 100 (max)

পান /api/v1/affiliates/me/

আপনার Affiliate রেকর্ড পেতে

উদাহরণ অনুরোধ

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 নির্ধারণ

এইসব সহ প্রতিটি এন্ডপয়েন্টের জন্য মেশিন-পড়ারযোগ্য স্পেসিফিকেশন নিচে দেয়া হয়েছে, এবং আপনি এপিআই রেফারেন্স পাতায় তা ব্রাউজ করতে পারেন।

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

প্রতি অ্যাকাউন্টে হারের সীমা: 1000 / hour