Қосылғандар API

Сіздің серіктесіңіздің журналын, ұсыныстарыңызды, комиссияларыңыз бен төлемдеріңізді оқып, төлем параметрлерін өзгертіп, төлемді сұраңыз. Әрбір аяқтау нүктесі API жетонына ие серіктес тіркелгісіне әсер етеді.

Соңғы нүктелер 7 endpoints

Негізгі жол /api/v1/affiliates

Аяқтау нүктелері мен белгі ауқымы

Тіркелгі, содан кейін Жасаушылар бөлімінде токен құрып, төмендегі аяқтау нүктелерінің қажет ететін ауқымын беріңіз. Қосылмайтын тіркелгі тіркелуден басқа барлық аяқтау нүктелерінен 404 дегенді алады.

Аяқтау нүктесі	Ауқымы	Сипаттамасы
`GET /affiliates/me/`	`affiliates:read`	Сіздің серіктесіңіздің журналы, балансы және сілтемесі
`GET /affiliates/referrals/`	`affiliates:read`	Сіздің сілтемеңіз арқылы тіркелген тіркелгілер
`GET /affiliates/commissions/`	`affiliates:read`	Сіздің ұсынысыңыздың төлемінен алынған комиссия
`GET /affiliates/payouts/`	`affiliates:read`	Сұралған және төленген төлемдер
`PATCH /affiliates/settings/`	`affiliates:update`	төлем әдісін, PayPal эл. поштасын, Stripe тіркелгісін немесе ең төменгі төлем мөлшерін өзгерту `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Қаржыңызды ең төменгі сомаға жеткенше төлеп беру. Бір мезгілде тек бір төлемді күту керек.
`POST /affiliates/signup/`	`affiliates:create`	Партнерлік бағдарламаға қосылыңыз. Payout_ method (paypal немесе stripe) дегенді paypal_ email немесе stripe_ account_ id дегенмен жіберіңіз.

The referrals, commissions and payouts lists are paginated: each response has count, next, previous and results. Use page to move through them and page_size to change how many items each page holds. Money values are returned as decimal strings. page_size: 25 (default), 100 (max)

АЛУ /api/v1/affiliates/me/

Сіздің қатынасыңыздың жазуын алу

Мысал сұрау

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

Мысал жауап

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

Жауап өрістері

Өріс	Түрі	Сипаттамасы
`status`	string	күтіп тұрған, белсенді, тоқтатқан не аяқталған. Тек белсенді серіктестер ғана төлемді сұрай алады.
`commission_rate`	decimal string	Комиссия пайыз ретінде, бөлшек емес `20.00 = 20%`
`cookie_days`	integer	Сілтемені түрткенде қанша күн сақталатынын көрсету
`balance`	decimal string	Құнды және төленбеген
`total_earned` / `total_paid`	decimal string	Жалпы комиссиясы мен төлем сомасы

Рефералдар, комиссиялар және төлемдер

Нәтижелердегі әрбір нысанның келесі өрістері бар:

Аяқтау нүктесі	Өріс
`/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`

Бағдарламаның күйі күтілетін, белсенді немесе доғарылған. Комиссия күйі күтілетін, рұқсат етілген, төленген немесе доғарылған. Сатып алу күйі күтілетін, өңделуде, аяқталды немесе жаңылды.

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

Жауап күйінің кодтары

200	Сәтті
403	API токені жоқ немесе жарамсыз, немесе токеннің қажетті рұқсаты жоқ
404	Бұл тіркелгі әлі ынтымақтас емес

OpenAPI спецификациясы

Әрбір аяқтау нүктесінің, соның ішінде мыналардың да, машина оқыйтын сипаттамасы төменде келтірілген, оны API сілтеме бетінде интерактивті түрде қарап шығуға болады.

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

Тіркелгінің жылдамдық шегі: 1000 / hour

VPS.org API