API affiliate

Leggere il record di affiliazione, referrals, commissioni e pagamenti, cambiare le impostazioni di pagamento e richiedere una sovvenzione. Ogni endpoint agisce sul conto di affiliazione che possiede il token API.

Punti finali 7 endpoints

Percorso di base /api/v1/affiliates

Endpoint e campi di applicazione del token

Crea un token in Account, poi Sviluppatori, e dagli gli scopi gli endpoint di seguito bisogno. Un account che non è una filiale ottiene 404 da ogni endpoint tranne registrazione.

Punto finale	Campo di applicazione	Designazione delle merci
`GET /affiliates/me/`	`affiliates:read`	Il tuo record di affiliazione, equilibrio e collegamento di referral
`GET /affiliates/referrals/`	`affiliates:read`	Account registrati tramite il link
`GET /affiliates/commissions/`	`affiliates:read`	Commissioni guadagnate sui pagamenti dei vostri referral
`GET /affiliates/payouts/`	`affiliates:read`	Pagamenti richiesti e pagati
`PATCH /affiliates/settings/`	`affiliates:update`	Cambia il metodo di pagamento, PayPal e-mail, conto Stripe o importo minimo di pagamento `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Richiedi un pagamento del tuo saldo una volta che raggiunge il minimo. Solo un pagamento in attesa alla volta.
`POST /affiliates/signup/`	`affiliates:create`	Unisciti al programma di affiliazione. Inviare payout_method (paypal o stripe) con paypal_email o stripe_account_id.

Le liste di referral, commissioni e pagamenti sono paginate: ogni risposta ha il conto, il prossimo, precedente e i risultati. Usa la pagina per spostarli e page_size per cambiare il numero di elementi che ciascuna pagina contiene. I valori dei soldi vengono restituiti come stringhe decimali. page_size: 25 (default), 100 (max)

OTTENERE /api/v1/affiliates/me/

Ottieni il tuo record di affiliazione

Richiesta di esempio

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

Esempio di risposta

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

Campi di risposta

Campo	Tipo	Designazione delle merci
`status`	string	solo gli affiliati attivi possono richiedere pagamenti.
`commission_rate`	decimal string	Commissione in percentuale, non in frazione `20.00 = 20%`
`cookie_days`	integer	Quanti giorni viene ricordato un click sul tuo link
`balance`	decimal string	Guadagnato e non ancora pagato
`total_earned` / `total_paid`	decimal string	Commissioni a vita guadagnate e importo a vita versato

Referrals, Commissioni e Payout

Ogni elemento nei risultati ha questi campi:

Punto finale	Campo
`/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`

Lo stato di rinvio è in sospeso, attivo o annullato. Lo stato della Commissione è in sospeso, approvato, pagato o annullato. Lo stato di pagamento è in sospeso, l'elaborazione, completato o non riuscito.

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

Codici di stato della risposta

200	Successo
403	Token API mancante o non valido, o il token non ha il permesso richiesto
404	Questo account non è ancora un affiliato

Specifica OpenAPI

La specifica leggibile da macchina per ogni endpoint, compresi questi, è qui sotto, e si può navigare interattivamente sulla pagina di riferimento API.

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

Limite di tasso per conto: 1000 / hour

VPS.org API