Աշխատանքային խումբ

Կարդալ ձեր համագործակցողի ռեգիստրը, հղումները, հանձնարարականները և վճարումները, փոխել ձեր վճարման պարամետրերը և պահանջել վճարում։ Յուրաքանչյուր վերջնական կետ գործում է համագործակցողի հաշվին, որը API token-ի սեփականատեր է։

Վերջնակետեր 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`	Միացեք համագործակցային ծրագրին։ Առաջարկեք payment_method (paypal կամ stripe) paypal_email կամ stripe_account_id-ով։

Հղումների, հանձնարարությունների և վճարումների ցանկերը էջավորված են. յուրաքանչյուր պատասխան ունի թվաբանություն, հաջորդ, նախորդ և արդյունքներ։ Կիրառեք page ՝ դրանք անցնելու համար և page_size ՝ յուրաքանչյուր էջում առկա տարրերի քանակը փոխելու համար։ Փողային արժեքները վերադարձվում են որպես տատանվող տողեր։ 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 token-ը բացակայում է, կամ token-ը չունի անհրաժեշտ թույլտվություն
404	Այս հաշիվը դեռևս չի ճանաչվում որպես գործընկեր

OpenAPI հատկություններ

Յուրաքանչյուր վերջնական կետ, ներառյալ այս կետեր, համար մեքենայով կարդացվող հատկությունները ներքևում են, և դուք կարող եք ինտերակտիվ կերպով որոնել դրանք API հղման էջում։

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

Ընդհանուր 1000 / hour

VPS.org API