Afilianty API

Przeczytaj rekord partnerski, referencje, prowizje i wypłaty, zmieni ustawienia wypłaty i zażądaj wypłaty. Każdy punkt końcowy działa na konto partnerskie, które posiada token API.

Punkty końcowe 7 endpoints

Ścieżka bazowa /api/v1/affiliates

Punkty końcowe i zakresy punktów

Stwórz żeton w koncie, następnie Programatorzy, i uzyskać zakresy punktów końcowych poniżej potrzebne. Konto, które nie jest partnerem, otrzymuje 404 z każdego punktu końcowego z wyjątkiem rejestracji.

Punkt końcowy	Zakres	Opis
`GET /affiliates/me/`	`affiliates:read`	Twoja rejestracja zależna, bilans i link referencyjny
`GET /affiliates/referrals/`	`affiliates:read`	Rachunki, które podpisywały się przez link
`GET /affiliates/commissions/`	`affiliates:read`	Komisja zasługuje na płatności z wnioskiem
`GET /affiliates/payouts/`	`affiliates:read`	Wypłaty wymagane i wypłacone
`PATCH /affiliates/settings/`	`affiliates:update`	Zmień metodę wypłaty, e-mail PayPal, konto Stripe lub minimalną kwotę wypłaty `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Proszę o wypłatę salda, gdy osiągnie minimalny poziom.
`POST /affiliates/signup/`	`affiliates:create`	Dołącz do programu partnerskiego. Wyślij payout_method (paypal lub pasek) z paypal_email lub pas_account_id.

Referencje, prowizje i wypłaty są paginowane: każda odpowiedź liczy, następne, poprzednie i wyniki. Użyj strony, aby przejść przez nie i page_size, aby zmienić ilość pozycji każdej strony. Wartości pieniężne są zwracane jako wiersz dziesięciocy. page_size: 25 (default), 100 (max)

DOSTAWAĆ /api/v1/affiliates/me/

Pobierz swój rycerz pomocniczy

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Pola odpowiedzi

Pole	Typ	Opis
`status`	string	Tylko aktywne jednostki zależne mogą zażądać wypłaty.
`commission_rate`	decimal string	Komisja w procentach, a nie w ułamku `20.00 = 20%`
`cookie_days`	integer	Ile dni przycisk kliknięcia na link jest zapamiętany
`balance`	decimal string	Zasługiwane i niewypłacane
`total_earned` / `total_paid`	decimal string	Prowizja dożywotnia i kwota wypłacana przez dożywocie

Wniosek, Komisja i wypłaty

Każda pozycja w wynikach zawiera następujące pola:

Punkt końcowy	Pole
`/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`

Status odwołania jest w oczekiwaniu, aktywny lub anulowany. Status Komisji jest w oczekiwaniu, zatwierdzony, zapłacony lub anulowany. Status wypłaty jest w oczekiwaniu, przetwarza, zakończony lub nie.

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

Kody statusu odpowiedzi

200	Sukces
403	Brak lub nieprawidłowy token API, lub token brakuje wymaganego pozwolenia
404	Rachunek ten nie jest jeszcze powiązanym

Specyfikacja OpenAPI

Specyfikacja do odczytu maszynowego dla każdego punktu końcowego, w tym tych, jest poniżej, i można ją interaktywnie przeglądać na stronie API.

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

Limit stawki na konto: 1000 / hour

VPS.org API