VPS.org API

Dokumentasi API REST

Affiliates API

Baca catatan afiliasi Anda, referensi, komisi dan pembayaran, ganti pengaturan pembayaran Anda dan minta pembayaran. Setiap titik aksi di akun afiliasi yang memiliki token API.

Titik akhir 7 endpoints
Jalur Dasar /api/v1/affiliates

Titik Akhir dan Scope Token

Buat token di Akun, lalu Pengembang, dan berikan lingkup titik-titik akhir di bawah kebutuhan. Sebuah akun yang bukan afiliasi mendapat 404 dari setiap titik akhir kecuali signup.

Titik Akhir Scope Deskripsi
GET /affiliates/me/affiliates:readCatatan afiliasimu, keseimbangan dan hubungan rujukan
GET /affiliates/referrals/affiliates:readAkun yang mendaftar melalui link Anda
GET /affiliates/commissions/affiliates:readKomisi mendapatkan pada pembayaran referrals Anda '
GET /affiliates/payouts/affiliates:readPembayaran diminta dan dibayar
PATCH /affiliates/settings/affiliates:updateUbah metoda payout, Email PayPal, akun Stripe atau jumlah pembayaran minimum min_payout_amount ≥ 10.00
POST /affiliates/request-payout/affiliates:createPermintaan pembayaran dari saldo Anda ketika mencapai minimum. Hanya satu pembayaran tertunda pada suatu waktu.
POST /affiliates/signup/affiliates:createGabung dengan program afiliasi. Kirim payout_method (paypal atau stripemail) dengan paypal_email atau stripe_account_id.

Rujukan, komisi, dan pembayaran daftar yang dipasarkan: setiap respon telah dihitung, selanjutnya, dan hasilnya. Gunakan halaman untuk bergerak melaluinya dan halaman_size untuk mengubah berapa banyak item yang dipegang. Nilai uang dikembalikan sebagai string desimal. page_size: 25 (default), 100 (max)

MENDAPATKAN /api/v1/affiliates/me/

Dapatkan Catatan Kekeluargaan 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 Jawaban

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

Kolom Respons

Ruas Jenis Deskripsi
statusstringTunda, aktif, ditangguhkan atau dihentikan. Hanya afiliasi aktif yang dapat meminta pembayaran.
commission_ratedecimal stringKomisi sebagai persentase, bukan pecahan 20.00 = 20%
cookie_daysintegerBerapa hari klik pada link Anda diingat
balancedecimal stringDiperoleh dan belum dibayar
total_earned / total_paiddecimal stringKomisi seumur hidup diperoleh dan jumlah hidup dibayar

ReferaI, Komisi dan Pembayaran

Setiap item hasilnya memiliki bidang ini:

Titik Akhir Ruas
/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 tertunda, aktif atau dibatalkan. Status komisi tertunda, disetujui, dibayar atau dibatalkan. Status pembayaran tertunda, pemrosesan, 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"
    }
  ]
}

Kode Status Respons

200 Berhasil
403 Hilang atau token API tak valid, atau token kurang izin yang diperlukan
404 Akun ini belum berafiliasi

Spesifikasi OpenAPI

Spek yang dapat dibaca mesin untuk setiap titik akhir, termasuk ini, di bawah ini, dan Anda dapat menelusuri secara interaktif pada halaman referensi API.

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

Tingkat batas per akun: 1000 / hour