Συνεργάτες API

Διαβάστε το αρχείο θυγατρικών σας, αναφορές, προμήθειες και πληρωμές, αλλάξτε τις ρυθμίσεις πληρωμής σας και ζητήστε μια πληρωμή.

Τελικά σημεία 7 endpoints

Βασική διαδρομή /api/v1/affiliates

Τελικά σημεία και πεδία εφαρμογής για το πληκτρολόγιο

Create a token in Account, then Developers, and give it the scopes the endpoints below need. An account that is not an affiliate gets 404 from every endpoint except signup.

Τέλος	Πεδίο εφαρμογής	Description
`GET /affiliates/me/`	`affiliates:read`	Ο σύνδεσμος εγγραφής θυγατρικών σας, ισορροπίας και παραπομπής
`GET /affiliates/referrals/`	`affiliates:read`	Λογαριασμοί που υπέγραψαν μέσω του συνδέσμου σας
`GET /affiliates/commissions/`	`affiliates:read`	Προμήθειες που κερδίσατε από τις πληρωμές σας
`GET /affiliates/payouts/`	`affiliates:read`	Αιτούμενες και καταβληθείσες πληρωμές
`PATCH /affiliates/settings/`	`affiliates:update`	Αλλαγή μεθόδου πληρωμής, email PayPal, Stripe λογαριασμό ή ελάχιστο ποσό πληρωμής `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Ζητήστε μια πληρωμή του υπολοίπου σας μόλις φτάσει στο ελάχιστο σας.
`POST /affiliates/signup/`	`affiliates:create`	Στείλτε την μέθοδο πληρωμής (paypal ή rie) με paypal_email ή rie_account_id.

Οι αναφορές, οι προμήθειες και οι λίστες πληρωμών είναι σελιδοποιημένες: κάθε απάντηση έχει μετρήσει, επόμενο, προηγούμενο και τα αποτελέσματα. Χρησιμοποιήστε τη σελίδα για να μετακινήσετε μέσα από αυτές και τη σελίδα_size για να αλλάξετε πόσα στοιχεία κάθε σελίδα κατέχει. page_size: 25 (default), 100 (max)

ΠΑΙΡΝΩ /api/v1/affiliates/me/

Πάρτε το αρχείο θυγατρικών σας

Παράδειγμα Αιτήματος

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

Παράδειγμα απάντησης

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

Πεδία απόκρισης

Πεδίο	Τύπος	Description
`status`	string	μόνο οι ενεργοί συνεργάτες μπορούν να ζητήσουν πληρωμές.
`commission_rate`	decimal string	Επιτροπή ως ποσοστό, όχι κλάσμα `20.00 = 20%`
`cookie_days`	integer	Πόσες μέρες θυμόμαστε ένα κλικ στο σύνδεσμο σας
`balance`	decimal string	Εκμισθώθηκε και δεν έχει ακόμη πληρωθεί
`total_earned` / `total_paid`	decimal string	Προμήθεια διάρκειας ζωής που κερδίζεται και ποσό ζωής

Αναφορές, Προμήθειες και Απολαβές

Κάθε αντικείμενο σε αποτελέσματα έχει τα εξής πεδία:

Τέλος	Πεδίο
`/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`

Το καθεστώς της Επιτροπής εκκρεμεί, εγκρίνεται, καταβληθεί ή ακυρωθεί. Το καθεστώς πληρωμής εκκρεμεί, επεξεργάζεται, ολοκληρώνεται ή απέτυχε.

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

Κωδικοί κατάστασης απόκρισης

200	Επιτυχία
403	Λείπει ή άκυρο API, ή το σύμβολο στερείται της απαιτούμενης άδειας
404	Αυτός ο λογαριασμός δεν είναι ακόμα συνδεδεμένος

Προδιαγραφή OpenAPI

Η εύχρηστη από μηχάνημα προδιαγραφή για κάθε τελικό σημείο, συμπεριλαμβανομένων αυτών, είναι παρακάτω, και μπορείτε να την περιηγηθείτε διαδραστικά στη σελίδα αναφοράς API.

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

Όριο επιτοκίου ανά λογαριασμό: 1000 / hour

VPS.org API