Affiliates API

Læs din affiliate rekord, henvisninger, provisioner og udbetalinger, ændre dine udbetalingsindstillinger og anmode om en udbetaling. Hver endpoint handler på affiliate konto, der ejer API token.

Endepunkter 7 endpoints

Basissti /api/v1/affiliates

Endepunkter og token- Scopes

Opret en token på kontoen, så udviklere, og give det omfanget af endpoints nedenfor behov. En konto, der ikke er en affiliate får 404 fra hvert endpoint undtagen tilmelding.

Slutpunkt	Anvendelsesområde	Description
`GET /affiliates/me/`	`affiliates:read`	Din affiliate rekord, balance og henvisning link
`GET /affiliates/referrals/`	`affiliates:read`	Kontoer, der tilmeldes via dit link
`GET /affiliates/commissions/`	`affiliates:read`	Kommissioner, der er blevet gjort fortjent til Deres henvisningsbetalinger
`GET /affiliates/payouts/`	`affiliates:read`	Udbetalinger, der anmodes om og betales
`PATCH /affiliates/settings/`	`affiliates:update`	Ændr udbetalingsmetode, PayPal e-mail, Stripe-konto eller mindste udbetalingsbeløb `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Anmod om udbetaling af din saldo, når det når dit minimum. Kun én afventer udbetaling ad gangen.
`POST /affiliates/signup/`	`affiliates:create`	Deltag i affiliate program. Send udbetaling_metode (paypal eller stribe) med paypal_email eller stribe_account_id.

De henvisninger, provisioner og udbetalinger lister pagineres: hver svar har tæller, næste, tidligere og resultater. Brug side til at flytte gennem dem og side_ størrelse til at ændre, hvor mange elementer hver side holder. Penge værdier returneres som decimal strenge. page_size: 25 (default), 100 (max)

FÅ /api/v1/affiliates/me/

Få din affiliate rekord

Eksempel på anmodning

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

Eksempel på 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"
}

Svarfelter

Felt	Type	Description
`status`	string	afventende, aktiv, suspenderet eller afsluttet. Kun aktive datterselskaber kan anmode om udbetalinger.
`commission_rate`	decimal string	Kommissionen i procent, ikke en brøkdel `20.00 = 20%`
`cookie_days`	integer	Hvor mange dage et klik på dit link er husket
`balance`	decimal string	Indtjent og endnu ikke udbetalt
`total_earned` / `total_paid`	decimal string	Lifetime provision optjent og levetid beløb udbetalt

Henvisninger, kommissioner og udbetalinger

Hvert punkt i resultaterne har disse felter:

Slutpunkt	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`

Henvisningsstatus er verserende, aktiv eller annulleret. Kommissionens status er verserende, godkendt, betalt eller annulleret. Udbetalingsstatus er verserende, behandling, afsluttet eller mislykkedes.

{
  "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	Succes
403	Manglende eller ugyldig API token, eller den token mangler den krævede tilladelse
404	Denne konto er ikke en affiliate endnu

OpenAPI- specifikation

Den maskinlæsbare spec for hvert endpoint, herunder disse, er nedenfor, og du kan gennemse det interaktivt på API referencesiden.

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

Procentgrænse pr. konto: 1000 / hour

VPS.org API