Mga Affiliate API

Basahin ang iyong affiliate record, mga referral, komisyon at payout, baguhin ang iyong mga setting ng payout at humiling ng isang payout. Ang bawat endpoint kumikilos sa affiliate account na nagmamay-ari ng API token.

Mga Endpoint 7 endpoints

Landas ng Batayan /api/v1/affiliates

Endpoints at Token Scopes

Lumikha ng isang token sa Account, pagkatapos Developers, at bigyan ito ng mga sakop ang endpoints sa ibaba kailangan. Ang isang account na hindi isang affiliate ay makuha ng 404 mula sa bawat endpoint maliban sa pag-signup.

Endpoint	Layunin	Paglalarawan
`GET /affiliates/me/`	`affiliates:read`	Ang iyong affiliate record, balanse at referral link
`GET /affiliates/referrals/`	`affiliates:read`	Account na nag-sign up sa pamamagitan ng iyong link
`GET /affiliates/commissions/`	`affiliates:read`	Mga komisyon na kinikita sa iyong mga referrals' pagbabayad
`GET /affiliates/payouts/`	`affiliates:read`	Pagbabayad na hiniling at nagbayad
`PATCH /affiliates/settings/`	`affiliates:update`	Baguhin ang paraan ng pagbabayad, PayPal email, Stripe account o minimum na halaga ng pagbabayad `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Humingi ng payout ng iyong balanse kapag umabot ito sa iyong minimum. Isang nakabinbing payout lamang sa isang oras.
`POST /affiliates/signup/`	`affiliates:create`	Ipadala ang payout_method (paypal o stripe) na may paypal_email o stripe_account_id.

Ang mga referrals, komisyon at mga listahan ng payout ay paginated: ang bawat tugon ay may bilang, susunod, nakaraang at mga resulta. Gamitin ang pahina upang ilipat sa pamamagitan ng mga ito at page_size upang baguhin kung gaano karaming mga item ang bawat pahina ay may hawak. Money halaga ay ibabalik bilang decimal string. page_size: 25 (default), 100 (max)

KUMUHA /api/v1/affiliates/me/

Kumuha ng iyong Affiliate Record

Halimbawang Kahilingan

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

Halimbawang Tugon

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

Mga Patlang ng Tugon

Patlang	Uri	Paglalarawan
`status`	string	pending, aktibo, suspendido o natapos. Aktif na affiliate lamang ang maaaring humiling ng payout.
`commission_rate`	decimal string	Komisyon bilang isang porsyento, hindi isang fraction `20.00 = 20%`
`cookie_days`	integer	Ilang araw ang isang click sa iyong link ay naalala
`balance`	decimal string	Natanggap at hindi pa nababayaran
`total_earned` / `total_paid`	decimal string	Lifetime commission na natanggap at lifetime amount na nabayad

Mga Referral, Komisyon at Pagbabayad

Ang bawat item sa mga resulta ay may mga patlang na ito:

Endpoint	Patlang
`/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`

Ang Referral status ay pending, aktibo o nakansela. Ang Commission status ay pending, naaprubahan, nagbayad o nakansela. Ang Payout status ay pending, naproseso, natapos o nabigo.

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

Mga Kodigo ng Katayuan ng Tugon

200	Tagumpay
403	Walang o hindi wastong API token, o ang token ay kulang ang kinakailangang pahintulot
404	Ang account na ito ay hindi isang affiliate pa

Talaan ng mga lansangan sa Kalakhang Maynila

Ang machine-readable spec para sa bawat endpoint, kabilang ang mga ito, ay sa ibaba, at maaari mong i-browse ito interactively sa API reference page.

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

Limitasyon ng rate kada account: 1000 / hour

VPS.org API