Samstarfsaðilar API

Lestu samstarfsaðilaskrána þína, tilvísanir, þóknun og útborganir, breyttu greiðslustillingum þínum og óska eftir útborgun.Hver endapunktur virkar á samstarfsaðilareikningnum sem á API-táknið.

Endapunktar 7 endpoints

Grunnslóð /api/v1/affiliates

Endapunktar og Token svið

Búðu til tákn í Account, síðan Developers og gefðu því umfangið sem endapunktarnir hér að neðan þurfa.Reikningur sem er ekki samstarfsaðili fær 404 frá öllum endapunktum nema skráningu.

Endir	Svið	Lýsing
`GET /affiliates/me/`	`affiliates:read`	Samstarfsaðilaskráin þín, jafnvægi og tilvísunartengill
`GET /affiliates/referrals/`	`affiliates:read`	Reikningar sem skráðu sig í gegnum hlekkinn þinn
`GET /affiliates/commissions/`	`affiliates:read`	Þóknun sem þú færð á greiðslum tilvísana þinna
`GET /affiliates/payouts/`	`affiliates:read`	Útborgun beðið og greidd
`PATCH /affiliates/settings/`	`affiliates:update`	Breyttu útborgunaraðferð, PayPal tölvupósti, Stripe reikningi eða lágmarks útborgun upphæð `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Beiðni um úttekt á innistæðu þinni þegar hún nær lágmarki þínu. Aðeins einn úttektarbeiðni í einu.
`POST /affiliates/signup/`	`affiliates:create`	Senda payout_method (paypal eða stripe) með paypal_email eða stripe_account_id.

Tilvísanir, umboð og útborgunarlistar eru síður: hvert svar hefur fjölda, næsta, fyrri og niðurstöður. Notaðu síðu til að fara í gegnum þá og page_size til að breyta fjölda hluta á hverri síðu. Peningar eru skilað sem tugi strengja. page_size: 25 (default), 100 (max)

FÁ /api/v1/affiliates/me/

Fáðu samstarfsaðilaskrá þína

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field	Tegund	Lýsing
`status`	string	Aðeins virkir samstarfsaðilar geta óskað eftir útborgun.
`commission_rate`	decimal string	Þóknun sem prósentuhlutfall, ekki brot `20.00 = 20%`
`cookie_days`	integer	Hversu margir dagar smellur á tengilinn þinn er minnst
`balance`	decimal string	Áunnin og ekki enn greitt út
`total_earned` / `total_paid`	decimal string	Æviþóknun sem fengin er og æviupphæð greidd út

Tilvísanir, þóknun og útborganir

Hvert atriði í niðurstöðum hefur þessa reiti:

Endir	Field
`/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`

Staða tilvísunar er í bið, virk eða hætt. Staða þóknunar er í bið, samþykkt, greidd eða hætt. Staða útborgunar er í bið, unnið úr, lokið eða mistókst.

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

Kóðar fyrir svörunarstöðu

200	Velgengni
403	Vantar eða ógilt API tákn, eða táknið hefur ekki nauðsynleg leyfi
404	Þessi reikningur er ekki tengdur ennþá

OpenAPI forskrift

Véllesanleg forskrift fyrir hvern endapunkt, þar á meðal þessar, er hér að neðan og þú getur flett henni gagnvirkt á API-tilvísunarsíðunni.

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

Takmörk á reikning: 1000 / hour

VPS.org API