VPS.org API

Dọkumenti

Afọ́ọ̀ltụ̀ API

Gụọ ndekọ gị, ndepụta, n'okpuru na nkwụghachi, gbanwee nkwụghachi gị na-achọ nkwụghachi. Ihe niile na-eme na akaụntụ n'okpuru nke nwere API Token.

Isi njedebe 7 endpoints
Ụzọ Ntọala /api/v1/affiliates

Nnukwu ebe n'oche na Token Scopes

Kewapụta token na Akaụntụ, mgbe ahụ Developers, ma nye ya n'ime ihenhọrọ ndị ahụ n'okpuru mkpa. Akaụntụ nke abụghị onye na-ejikọta na-enweta 404 site n'ebe ngwụcha ọbụla n'agbanyeghị ntinye aka.

Ebemkpofuozi Òtù Ndesịta ozi ndị ahụ
GET /affiliates/me/affiliates:readN'ime gị affiliate ndekọ, ego na-enyemaka njikọ
GET /affiliates/referrals/affiliates:readAkaụntụ ndị ahụ banye site na ụzọ njikọ gị
GET /affiliates/commissions/affiliates:readNhazi nke n'echekwa na nkwụghachi nke ndị na-ewere gị
GET /affiliates/payouts/affiliates:readNhazi ndị ahụ achọrọ nakwa akwụla ha
PATCH /affiliates/settings/affiliates:updateGbanye ụzọ nkwụghachi, PayPal ozi-e, akaụntụ Stripe mọọbụ ego nkwụghachi dị ala min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createNweta nkwụghachi nke ego gị mgbe ọ na-abịaru nso n'okpuru gị. Ọnụnọ nkwụghachi na-abịaru nso n'otu oge.
POST /affiliates/signup/affiliates:createTinye na mmemme affiliate. Ziga payout_method (paypal mọọbụ stripe) na paypal_email mọọbụ stripe_account_id.

Nkọwa, nlekọta na ndesịta nkwụghachi ego bụ pageted: nzaghachi ọbụla nwere ọnụọgụgụ, nke na-esonụ, nke gara aga na nsonaazụ. Jiri peeji ka banye n'ime ha na page_size ka gbanwee ihenhọrọ ole ihuakwụkwọ ọbụla na-echekwa. Uru ego a na-ebuli n'ime decimale strings. page_size: 25 (default), 100 (max)

Nweta /api/v1/affiliates/me/

Nweta Affiliate Record gị

Arịrịọ Ihe Nlereanya

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);

Ihe Nlereanya Azịza

{
  "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"
}

Ubi Nzaghachi

_Òkè Ụdị Ndesịta ozi ndị ahụ
statusstringna-echere, na-arụ ọrụ, ewepụtụla ma ọ bụ kwụsịtụrụ. Ọbụna ndị ọrụ na-arụ ọrụ ka nwere ike ịjụ maka nkwụghachi.
commission_ratedecimal stringNhazi dịka pasentị, ọ bụghị fraction 20.00 = 20%
cookie_daysintegerOge ole ka a ga-echekwa nchọgharị na ụzọ njikọ gị
balancedecimal stringÉbūbúlàrị̀ ma ọ̀ bụghị́ n'ebe ahụ
total_earned / total_paiddecimal stringNhazi nke ndụ na-echekwa na ọnụọgụgụ nke ndụ na-akwụ ụgwọ

Nkọwapụta, n'ime na n'ime

Ihenhọrọ ọbụla na nsonaazụ nwere ebe ndị a:

Ebemkpofuozi _Òkè
/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

Nhazi nlebara anya bụ n'okpuru, na-arụ ọrụ mọọbụ ewepụtụla. Nhazi nlebara anya bụ n'okpuru, ekwenyela, akwụla maọbụ ewepụtụla. Nhazi nkwụghachi bụ n'okpuru, na-arụ ọrụ, zuru ezu mọọbụ ewepụtụla.

{
  "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"
    }
  ]
}

Koodu Ọnọdụ Nzaghachi

200 Ńkwádò
403 Ndehie mọọbụ token API adịghị mma, mọọbụ token enweghị ikikembanye achọrọ
404 Akaụntụ a abụghị onye na-ejikọta

OpenAPI Spéèsìfọ́ọ̀ltụ̀

Spéèsì nke a ga-agụta site na igwe maka ebemkpofuozi ọbụla, gụnyere ndị a, dị n'okpuru, na ị ga-enwe ike ịgụta ya n'ụzọ n'ime na ibe ndesịta API.

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

Ónyénwē akaụntụ: 1000 / hour