API Affiliates

Titik Akhir dan Skop Token

Cipta token dalam Akaun, kemudian Pembangun, dan beri ia skop yang titik akhir di bawah perlukan. Akaun yang bukan afiliasi akan mendapat 404 dari setiap titik akhir kecuali pendaftaran.

Titik Akhir	Skop	Huraian
`GET /affiliates/me/`	`affiliates:read`	Rekod afiliasi anda, baki dan pautan rujukan
`GET /affiliates/referrals/`	`affiliates:read`	Akaun yang mendaftar melalui pautan anda
`GET /affiliates/commissions/`	`affiliates:read`	Komisen yang diperolehi dari bayaran rujukan anda
`GET /affiliates/payouts/`	`affiliates:read`	Pembayaran diminta dan dibayar
`PATCH /affiliates/settings/`	`affiliates:update`	Ubah kaedah bayaran, emel PayPal, akaun Stripe atau jumlah bayaran minimum `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Minta bayaran baki anda bila ia mencapai minimum anda. Hanya satu bayaran menunggu pada satu masa.
`POST /affiliates/signup/`	`affiliates:create`	Sertai program affiliate. Hantar kaedah_pembayaran (paypal atau stripe) dengan emel_paypal atau id_akaun_stripe.

Senarai rujukan, komisyen dan bayaran di pagekan: setiap maklum balas mempunyai kiraan, seterusnya, terdahulu dan hasil. Guna page untuk bergerak melaluinya dan page_size untuk mengubah berapa banyak item setiap halaman miliki. Nilai wang dikembalikan sebagai rentetan desimal. page_size: 25 (default), 100 (max)

DAPATKAN /api/v1/affiliates/me/

Dapatkan Rekod Affiliate Anda

Contoh Permintaan

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

Contoh Respons

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

Medan Respons

Medan	Jenis	Huraian
`status`	string	menunggu, aktif, ditangguh atau dihentikan. Hanya afiliasi aktif boleh meminta bayaran.
`commission_rate`	decimal string	Komisyen sebagai peratusan, bukan pecahan `20.00 = 20%`
`cookie_days`	integer	Berapa banyak hari klik pada pautan anda diingat
`balance`	decimal string	Diperoleh dan belum dibayar
`total_earned` / `total_paid`	decimal string	Komisen seumur hidup diperoleh dan jumlah seumur hidup dibayar

Rujukan, Komisyen dan Pembayaran

Setiap item dalam hasil mempunyai medan ini:

Titik Akhir	Medan
`/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`

Status rujukan adalah menunggu, aktif atau dibatalkan. Status komisyen adalah menunggu, diluluskan, dibayar atau dibatalkan. Status bayaran adalah menunggu, pemprosesan, selesai atau gagal.

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

Kod Status Respons

200	Kejayaan
403	Token API hilang atau tidak sah, atau token tidak mempunyai keizinan yang diperlukan
404	Akaun ini bukan lagi affiliate

Spesifikasi OpenAPI

Spesifikasi boleh baca mesin bagi setiap titik akhir, termasuk ini, adalah di bawah, dan anda boleh layari ia secara interaktif pada halaman rujukan API.

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

Had kadar per akaun: 1000 / hour

VPS.org API