Tilknyttede API

Les registreringen av tilknyttede foretak, henvisninger, provisjoner og utbetalinger, endre dine utbetalingsinnstillinger og be om en utbetaling. Hvert endepunkt fungerer på den tilknyttede kontoen som eier API- symbolet.

Endepunkter 7 endpoints

Basissti /api/v1/affiliates

Endepunkter og tegnområde

Lag et symbol i kontoen, så utviklerne, og oppgi omfanget av endepunktene nedenfor. En konto som ikke er et tilknyttet foretak får 404 fra hvert endepunkt unntatt registrering.

Endepunkt	Virkeområde	Beskrivelse
`GET /affiliates/me/`	`affiliates:read`	Tilknyttet dokumentasjon, balanse og henvisning
`GET /affiliates/referrals/`	`affiliates:read`	Kontoer som har logget på gjennom lenken din
`GET /affiliates/commissions/`	`affiliates:read`	Provisjoner som mottar betaling for henvisninger
`GET /affiliates/payouts/`	`affiliates:read`	Utbetalinger som det anmodes om og er betalt for
`PATCH /affiliates/settings/`	`affiliates:update`	Endre utbetalingsmetode, PayPal e- post, strippkonto eller minste utbetalingsbeløp `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Be om en utbetaling av din saldo når den når ditt minimum. Bare én av de kommende utbetalingene av gangen.
`POST /affiliates/signup/`	`affiliates:create`	Bli med i programmet tilknyttet et tilknyttet foretak. Send utbetalnings_ metode (betalpal eller stripe) med paypal_ email eller stripe_ account_ ID.

Listene over henvisninger, provisjoner og utbetalinger er delt opp. Hvert svar har telling, neste, forrige og resultater. Bruk siden til å gå gjennom dem og sidestørrelse for å endre hvor mange elementer hver side har. Pengeverdier returneres som desimaler. page_size: 25 (default), 100 (max)

BLI /api/v1/affiliates/me/

Hent avfile- opptak

Eksempelforespørsel

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

Eksempelsvar

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

Svarfelt

Felt	Type	Beskrivelse
`status`	string	ventende, aktivt, midlertidig eller avsluttet. Bare aktive datterforetak kan be om utbetaling.
`commission_rate`	decimal string	Kommisjonen i prosent, ikke en brøk `20.00 = 20%`
`cookie_days`	integer	Hvor mange dager et klikk på lenka din blir husket
`balance`	decimal string	Opptjent og ennå ikke utbetalt
`total_earned` / `total_paid`	decimal string	Opptjent levetidsprovisjon og utbetalingsbeløp

Henvisninger, kommisjoner og utbetalinger

Hvert resultatfelt har disse feltene:

Endepunkt	Felt
`/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`

Henvisningsstatusen er på vent, aktiv eller annullert. Kommisjonens status er på vent, godkjent, betalt eller annullert. Utbetalingsstatusen er på vent, behandler, fullfører eller mislykket.

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

Svarstatuskoder

200	Vellykket
403	Mangler eller er ugyldig API- symbol, eller symbolet mangler tillatelse
404	Denne kontoen er ikke et datterforetak ennå

OpenAPI- spesifikasjon

De maskinlesbare spesifikasjonene for hvert endepunkt, inkludert disse, er nedenfor, og du kan bla den interaktivt på API referansesiden.

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

Prosentgrense per konto: 1000 / hour

VPS.org API