Affiliates API

Loppupisteet ja Token-ulottuvuudet

Luo tiliin tunniste, sitten kehittäjät, ja anna sille laajuudet, joita alla olevat päätetapahtumat tarvitsevat. Tili, joka ei ole affiliate, saa 404 jokaisesta päätepisteestä paitsi ilmoittautumisen.

Loppupiste	Soveltamisala	Tavaran kuvaus
`GET /affiliates/me/`	`affiliates:read`	Affiliate levy, tasapaino ja siirtolinkki
`GET /affiliates/referrals/`	`affiliates:read`	Tilit, jotka kirjautuivat linkin kautta
`GET /affiliates/commissions/`	`affiliates:read`	Lausuntopyyntöjenne maksuilla ansaitut toimeksiannot
`GET /affiliates/payouts/`	`affiliates:read`	Maksatukset pyydetty ja maksettu
`PATCH /affiliates/settings/`	`affiliates:update`	Vaihda maksutapaa, PayPal-sähköpostia, Stripe-tiliä tai minimivoittosummaa `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Pyydä voitto saldosi, kun se on minimissä. Vain yksi odottaa maksu kerrallaan.
`POST /affiliates/signup/`	`affiliates:create`	Liity kumppaniohjelmaan. Lähetä voitto_menetelmä (maksaja tai raita) paypal_emaililla tai stripe_account_idilla.

Lähetykset, palkkiot ja maksulistat on merkitty: jokainen vastaus on laskettu, seuraava, aiempi ja tulos. Käytä sivua, jolla voit liikkua niiden läpi, ja sivukokoa, jotta voit muuttaa kuinka monta kohdetta kullakin sivulla on. Raha-arvot palautetaan desimaalin kielinä. page_size: 25 (default), 100 (max)

SAADA /api/v1/affiliates/me/

Hanki kumppanin tiedot

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauskentät

Kenttä	Tyyppi	Tavaran kuvaus
`status`	string	Vain aktiiviset tytäryhtiöt voivat pyytää maksuja.
`commission_rate`	decimal string	Komissio prosentteina, ei murto-osaa `20.00 = 20%`
`cookie_days`	integer	Kuinka monta päivää klikkaamalla linkkiä muistetaan
`balance`	decimal string	Ansaitsi eikä maksanut vielä
`total_earned` / `total_paid`	decimal string	Elinkaaripalkkio ja maksettu elinikäinen palkkio

Lausuntopyynnöt, toimeksiannot ja maksusuoritukset

Jokaisella tuloksella on seuraavat kentät:

Loppupiste	Kenttä
`/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`

Asiaa koskeva lausunto on vireillä, aktiivinen tai peruutettu. Komission asema on vireillä, hyväksytty, maksettu tai peruutettu. Palautusoikeus on vireillä, käsittelyä, täytetty tai epäonnistunut.

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

Vastauksen tilakoodit

200	Onnistuminen
403	Puuttuva tai virheellinen API-tunnus tai postimerkki puuttuu vaaditusta luvasta
404	Tämä tili ei ole vielä tytäryhtiö

OpenAPI-erittely

Alla on jokaisen päätetapahtuman, myös näiden, koneluettava spes, ja voit selata sitä interaktiivisesti API-viitesivulla.

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

Tilikohtainen veroraja: 1000 / hour

VPS.org API