Àwọn Àkọ́gbégbé

Ka àkọlé àwòrán àwọn ìṣàmúlò-ètò, àwọn ìṣàmúlò-ètò, àwọn ìṣàmúlò-ètò àti àwọn ìṣàmúlò-ètò rẹ̀, yìí ìṣàmúlò-ètò rẹ̀ yipadà àti ìṣàmúlò-ètò kan. Àwọn ààtò ìparí gbogbó ní pàtó àwọn

Àwọn ìparí 7 endpoints

Ipa-ọna Ipilẹ /api/v1/affiliates

Àwọn ààyè-iṣẹ́ ìparí iṣẹ́ àti àwọn ààyè-iṣẹ́ tòké

Ṣẹ̀dà tokè nínú Àwọn Àkọ́gbègbè, àti Àwọn Àkọ́gbègbè, àtí fi àwọn ààyè tí àwọn ààyè ìsàlẹ̀-ilà. Àwọn Ààyè tí kò jẹ́ àwọn ààyè ìsàlẹ̀-ilà gba 404 láti inú àwọn ààyè ìsàlẹ̀-ilà gbogbò lọ́wọ́lọ́wọ́ nínú àwọn ààyè ìsàlẹ̀-ilà.

Àwọn Ààyè Ìjánu-ìsún	Àwọn Ìṣàmúlò-ètò	Àwọn Àkọlé
`GET /affiliates/me/`	`affiliates:read`	Àwọn àkọlé àwọn àkọlé àwọn àkọlé
`GET /affiliates/referrals/`	`affiliates:read`	Àwọn
`GET /affiliates/commissions/`	`affiliates:read`	Àwọn ìṣẹ̀dà tí a gbà nínú àwọn ìṣàmúlò-ètò rẹ̀
`GET /affiliates/payouts/`	`affiliates:read`	Àwọn ìṣàmúlò-ètò àti àwọn ìṣàmúlò-ètò
`PATCH /affiliates/settings/`	`affiliates:update`	Àwọn ìṣàmúlò-ètò ìṣàmúlò-ètò, àmì-ìwé PayPal, àwọn àwọn iroyin Stripe tàbí àwọn ìṣàmúlò-ètò ìpele kékeré `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Ǹgbègbè ìgbàdálẹ̀ tí a bá fi pamọ́ sínú ìṣàmúlò-ètò rẹ̀ nígbà tí o bá dé nínú ìpelé kékeré rẹ̀. Àwọn ìgbàdálẹ̀ tí a bá fi pamọ́ nígbà kan nínú àkókó kan.
`POST /affiliates/signup/`	`affiliates:create`	Ṣàfikún ìṣàmúlò-ètò agbẹ̀gbẹ̀. Fí àwọn àwọn ìṣàmúlò-ètò_ìgbà (paypal tàbí àwọn

Àwọn àtòjọ àwọn ìṣàmúlò-ètò, àwọn ìṣàmúlò-ètò àti àwọn ìṣàmúlò-ètò ní pánẹ́ẹ̀lì: àwọn ìrànwọ́ fún gbogbo wọn ní àwọn à page_size: 25 (default), 100 (max)

GBÀ /api/v1/affiliates/me/

Gba àkọlé rẹ

Àpẹẹrẹ Ìbéèrè

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

Àpẹẹrẹ Ìdáhùn

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

Àwọn Ààyè Ìdáhùn

Àwọn Ààyè-iṣẹ́	Irú	Àwọn Àkọlé
`status`	string	tí a tí n gbọ́, tí a ti n ṣiṣẹ́, tí a tí n dáwọ́ láti ṣiṣẹ́ tàbí tí a ti tí a ti n pà. Àwọn agbẹ̀gbẹ̀lì tí a n ṣiṣẹ́ ní lè beere àwọn ìṣàmúlò-ètò.
`commission_rate`	decimal string	Àwọn ààyè-iṣẹ́ bí àwọn ìpéwọ̀n, àti àwọn ìpàsẹ̀ `20.00 = 20%`
`cookie_days`	integer	Àwọn ọjọ́ wò nínú tí a tì gbọ́ pé tí a bá tẹ̀ lori líǹkì rẹ̀
`balance`	decimal string	Tí a fi pamọ́ àti àtí kò fi pamọ́
`total_earned` / `total_paid`	decimal string	Àwọn ìṣàmúlò-ètò ìṣàmúlò-ètò tí a gbà atí àwọn ìṣàmúlò-ètò tí a fi pamọ́

Àwọn ìṣàmúlò-ètò

Àkóónú fún àwọn àwọn ààyè-iṣẹ́ yìí:

Àwọn Ààyè Ìjánu-ìsún	Àwọn Ààyè-iṣẹ́
`/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`

Referral status is pending, active or cancelled. Commission status is pending, approved, paid or cancelled. Payout status is pending, processing, completed or failed.

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

Àwọn Kóòdù Ipò Ìdáhùn

200	Àwọn Ìṣàmúlò-ètò
403	Tokénà API tí kò bá jẹ́ tàbí tí kò bá jẹ́, tàbí tokénà náà kò ní ìṣẹ̀dà tí a fẹ́
404	Àwọn

Àwọn Àwọn Àkọ́lé

Àwọn àwọn ìṣàmúlò-ètò ìṣàfihàn-ìṣàfilọ́lẹ̀ fún àwọn ààyè-iṣẹ́ gbogbó, àti àwọn yìí, ní ààyè-iṣẹ́ yìí, àti àwọn tí o lè ṣàfihàn àwọn náà nípa àwọn ojú-ìwé ìṣàfilọ́lẹ̀ API.

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

Àwọn 1000 / hour

VPS.org API