Affiliates API

Endpoints uye Token Scopes

Create a token in Account, then Developers, and give it the scopes the endpoints below need. Account iyo haina kubatanidzwa inowana 404 kubva kune yega yega endpoint kunze kwekunge iri kurodha pasi.

Endpoint	Kutanga	Kutaura
`GET /affiliates/me/`	`affiliates:read`	Yako affiliate rekodhi, mari uye kukurudzira link
`GET /affiliates/referrals/`	`affiliates:read`	Akaunti dzakasimbiswa kuburikidza neyako link
`GET /affiliates/commissions/`	`affiliates:read`	Kubhadharwa kwemari yakapihwa pakubhadhara kwevaunokurudzira
`GET /affiliates/payouts/`	`affiliates:read`	Payouts akakumbira uye akabhadhara
`PATCH /affiliates/settings/`	`affiliates:update`	Change payout nzira, PayPal email, Stripe account kana minimum payout mari `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Kukumbira kubhadharwa kwemari yako kana yasvika pakubhadharwa kwemari yakanyanya. Kubhadharwa kwemari kunoitwa chete kana paine imwe mari iri kutarisirwa kubhadharwa.
`POST /affiliates/signup/`	`affiliates:create`	Kuungana muzvikwata zvedu. Send payout_method (paypal kana stripe) ne paypal_email kana stripe_account_id.

The referrals, commissions uye payouts mazita ari paginated: chero mashoko ane kutevera, kutevera, zvakapfuura uye results. Use page kuti kuchinja pakati pavo uye page_size kuti uite sei zvinhu zvakawanda pashure pazuva rimwe chete. Money mashoko anodzokera se decimal strings. page_size: 25 (default), 100 (max)

Tora /api/v1/affiliates/me/

Get Your Affiliate Record

Muenzaniso weChikumbiro

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

Muenzaniso weMhinduro

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

Minda Yemhinduro

_Firi	Rudzi	Kutaura
`status`	string	Kubhadhara kunogona kunge kuri kutarisirwa, kuenderera mberi, kumiswa kana kumiswa.
`commission_rate`	decimal string	Komisheni sechikamu chemazana, kwete sechikamu chemazana `20.00 = 20%`
`cookie_days`	integer	Mazuva mangani akasvetuka pane yako link anotoziva
`balance`	decimal string	Kuwana uye kwete kusvika parizvino
`total_earned` / `total_paid`	decimal string	Lifetime commission yakapihwa uye lifetime mari yakabhadharwa

Kudzokororwa, Commissions uye Payouts

Kana iwe ukawana mhedzisiro, sarudza imwe yezvinyorwa izvi:

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

Kutumira kwemumwe munhu kunotarisirwa, kuripo kana kumiswa. Kubhadhara kunotarisirwa, kupihwa, kubhadharwa kana kumiswa. Kubhadhara kunotarisirwa, kugadziriswa, kuitwa kana kukundikana.

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

Makodhi eMamiriro eMhinduro

200	Kubudirira
403	Kukanganisa kweAPI Token kana kuti Token haina mvumo yakakodzera
404	Account Details Account Details Iyi account haisi yepamberi

OpenAPI Kutaura

Machina-anoverenga spec yese endpoint, kusanganisira izvi, iri pasi, uye unogona browse ichi interactionally paAPI reference page.

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

Kubhadhara kurambidzwa paaccount: 1000 / hour

VPS.org API