API för affiliates

Läs din affiliate-post, remisser, provisioner och utbetalningar, ändra dina utbetalningsinställningar och begära en utbetalning. Varje endpoint agerar på affiliate-kontot som äger API- token.

Slutpunkter 7 endpoints

Basväg /api/v1/affiliates

Endpoints och Tokens omfattning

Skapa en token i Konto, sedan Utvecklare, och ge det omfattningen av de endpoints nedan behov. Ett konto som inte är en affiliate får 404 från varje slutpunkt utom registrering.

Slutpunkt	Tillämpningsområde	Varuslag
`GET /affiliates/me/`	`affiliates:read`	Din affiliate-skiva, balans och referens länk
`GET /affiliates/referrals/`	`affiliates:read`	Konton som registrerat sig via din länk
`GET /affiliates/commissions/`	`affiliates:read`	Provisioner som har tjänats på dina remissbetalningar
`GET /affiliates/payouts/`	`affiliates:read`	Begärda och betalda utbetalningar
`PATCH /affiliates/settings/`	`affiliates:update`	Ändra utbetalningsmetod, PayPal e-post, Stripe konto eller minsta utbetalningsbelopp `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Begär en utbetalning av ditt saldo när det når ditt minimum. Endast en väntande utbetalning i taget.
`POST /affiliates/signup/`	`affiliates:create`	Gå med i affiliate-programmet. Skicka utbetalning_metod (paypal eller rand) med paypal_email eller stripe_ account_id.

Remisser, provisioner och utbetalningslistor är sidig: varje svar har räkna, nästa, föregående och resultat. Använd sidan för att flytta igenom dem och sidstorlek för att ändra hur många objekt varje sida innehåller. Pengars värden returneras som decimalsträngar. page_size: 25 (default), 100 (max)

FÅ /api/v1/affiliates/me/

Hämta ditt affiliate-register

Exempelförfrågan

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

Exempelsvar

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

Svarsfält

Fält	Typ	Varuslag
`status`	string	väntande, aktiv, avstängd eller avslutad. Endast aktiva dotterbolag kan begära utbetalningar.
`commission_rate`	decimal string	Kommissionen i procent, inte en bråkdel `20.00 = 20%`
`cookie_days`	integer	Hur många dagar ett klick på din länk är ihågkommen
`balance`	decimal string	Tjänad och ännu inte betald
`total_earned` / `total_paid`	decimal string	Livstidsprovision och utbetalt livstidsbelopp

Hänskjutanden, kommissioner och utbetalningar

Varje punkt i resultatet har följande fält:

Slutpunkt	Fält
`/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`

Remissstatus är väntande, aktiv eller inställd. Kommissionens status är väntande, godkänd, betald eller inställd. Utbetalningsstatus är väntad, behandling, slutförande eller underkänd.

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

Svarsstatuskoder

200	Lyckades
403	Saknas eller ogiltig API- token, eller token saknar den behörighet som krävs
404	Detta konto är inte ett affiliate ännu

OpenAPI- specifikation

Den maskinläsbara specen för varje endpoint, inklusive dessa, är nedan, och du kan bläddra interaktivt på API-referenssidan.

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

Prisgräns per konto: 1000 / hour

VPS.org API