API für Partner

Lesen Sie Ihren Affiliate-Record, Empfehlungen, Provisionen und Auszahlungen, ändern Sie Ihre Auszahlungseinstellungen und fordern Sie eine Auszahlung. Jeder Endpunkt wirkt auf dem Affiliate-Konto, das das API-Token besitzt.

Endpunkte 7 endpoints

Basispfad /api/v1/affiliates

Endpunkte und Zeichenbereiche

Erstellen Sie ein Token in Konto, dann Entwickler, und geben Sie ihm die Bereiche die Endpunkte unter Bedarf. Ein Konto, das nicht ein Affiliate erhält 404 von jedem Endpunkt außer Anmeldung.

Endpunkt	Geltungsbereich	Description
`GET /affiliates/me/`	`affiliates:read`	Ihre Affiliate-Record, Balance und Empfehlung Link
`GET /affiliates/referrals/`	`affiliates:read`	Konten, die sich über Ihren Link registriert haben
`GET /affiliates/commissions/`	`affiliates:read`	Provisionen auf Ihre Überweisungen
`GET /affiliates/payouts/`	`affiliates:read`	Geforderte und bezahlte Auszahlungen
`PATCH /affiliates/settings/`	`affiliates:update`	Änderung Auszahlungsmethode, PayPal E-Mail, Stripe Konto oder Mindestauszahlungsbetrag `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Fordern Sie eine Auszahlung Ihres Gleichgewichts, sobald es Ihr Minimum erreicht. Nur eine ausstehende Auszahlung zu einer Zeit.
`POST /affiliates/signup/`	`affiliates:create`	Begleiten Sie das Affiliate-Programm. Senden Sie die Auszahlungs-Methode (paypal oder stripe) mit paypal_email oder stripe_account_id.

Die Empfehlungen, Provisionen und Auszahlungslisten werden paginiert: jede Antwort hat Zählung, nächste, vorherige und Ergebnisse. Verwenden Sie Seite, um durch sie zu bewegen und page_size zu ändern, wie viele Elemente jede Seite hält. Geldwerte werden als Dezimalzeichenfolgen zurückgegeben. page_size: 25 (default), 100 (max)

ERHALTEN /api/v1/affiliates/me/

Holen Sie sich Ihre Partner-Daten

Beispielanfrage

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

Beispielantwort

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

Antwortfelder

Feld	Typ	Description
`status`	string	bis, aktiv, ausgesetzt oder beendet. Nur aktive Partner können Auszahlungen anfordern.
`commission_rate`	decimal string	Kommission in Prozent, nicht in einem Bruchteil `20.00 = 20%`
`cookie_days`	integer	Wie viele Tage ein Klick auf Ihren Link erinnert wird
`balance`	decimal string	Verdient und noch nicht ausgezahlt
`total_earned` / `total_paid`	decimal string	Lebenslange Provision und lebenslanger Betrag ausgezahlt

Befassungen, Kommissionen und Auszahlungen

Jeder Artikel in den Ergebnissen hat diese Felder:

Endpunkt	Feld
`/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`

Der Status der Befassung ist anhängig, aktiv oder aufgehoben. Der Status der Kommission ist anhängig, genehmigt, bezahlt oder aufgehoben. Der Status der Auszahlung ist anhängig, verarbeitet, abgeschlossen oder fehlgeschlagen.

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

Antwortstatuscodes

200	Erfolg
403	Fehlendes oder ungültiges API-Token oder dem Token fehlt die erforderliche Berechtigung
404	Dieses Konto ist noch kein Partner

OpenAPI-Spezifikation

Die maschinenlesbare Spezifikation für jeden Endpunkt, einschließlich dieser, ist unten, und Sie können es interaktiv auf der API-Referenzseite durchsuchen.

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

Steuersatz je Konto: 1000 / hour

VPS.org API