સહયોગીઓ 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`	ચૂકવણી પદ્ધતિ, પેપાલ ઇમેઇલ, સ્ટ્રીપ ખાતું અથવા ન્યૂનતમ ચૂકવણી રકમ બદલો `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	જ્યારે તે તમારી ન્યૂનતમ સુધી પહોંચે ત્યારે તમારા બચતના ચૂકવણીની વિનંતી કરો. એક સમયે ફક્ત એક જ બાકી રહેલ ચૂકવણી.
`POST /affiliates/signup/`	`affiliates:create`	સહયોગી કાર્યક્રમમાં જોડાઓ. paypal_email અથવા stripe_account_id સાથે payout_method (paypal અથવા stripe) મોકલો.

સૂચનો, કમિશન અને ચૂકવણી યાદીઓ પાનાંઓમાં છે: દરેક જવાબ પાસે ગણતરી, આગળ, પહેલાનું અને પરિણામો છે. તેમને મારફતે જવા માટે પાનું વાપરો અને દરેક પાનું કેટલી વસ્તુઓ ધરાવે છે તે બદલવા માટે 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"
}

પ્રતિભાવ ક્ષેત્રો

ક્ષેત્ર	પ્રકાર	વર્ણન
`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