ਸਬੰਧਤ API

ਆਪਣੇ ਸਹਿਯੋਗੀ ਰਿਕਾਰਡ, ਹਵਾਲਾ, ਕਮਿਸ਼ਨ ਅਤੇ ਭੁਗਤਾਨ ਪੜ੍ਹੋ, ਆਪਣੀ ਭੁਗਤਾਨ ਸੈਟਿੰਗ ਬਦਲੋ ਅਤੇ ਭੁਗਤਾਨ ਦੀ ਮੰਗ ਕਰੋ। ਹਰ ਅੰਤ ਬਿੰਦੂ ਸਹਿਯੋਗੀ ਅਕਾਊਂਟ ਉੱਤੇ ਕੰਮ ਕਰਦਾ ਹੈ, ਜੋ ਕਿ 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 ਈ-ਮੇਲ, ਸਟਰੀਪ ਅਕਾਊਂਟ ਜਾਂ ਘੱਟੋ-ਘੱਟ ਭੁਗਤਾਨ ਰਕਮ ਬਦਲੋ `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/

ਆਪਣਾ ਸਹਿਯੋਗੀ ਰਿਕਾਰਡ ਲਵੋ

ਉਦਾਹਰਨ ਬੇਨਤੀ

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 ਸਪੈਸ਼ਫਿਕੇਸ਼ਨ

ਇਹਨਾਂ ਸਮੇਤ ਹਰੇਕ ਅੰਤ- ਬਿੰਦੂ ਲਈ ਮਸ਼ੀਨ- ਪੜ੍ਹਨਯੋਗ ਵੇਰਵਾ ਹੇਠਾਂ ਦਿੱਤਾ ਗਿਆ ਹੈ, ਅਤੇ ਤੁਸੀਂ API ਹਵਾਲਾ ਪੇਜ਼ ਉੱਤੇ ਆਪਸੀ ਤੌਰ ਉੱਤੇ ਇਸ ਨੂੰ ਝਲਕ ਸਕਦੇ ਹੋ ।

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

ਪ੍ਰਤੀ ਅਕਾਊਂਟ ਰੇਟ ਲਿਮਟ: 1000 / hour

VPS.org API