API de afiliados

Lea su registro de afiliados, referencias, comisiones y pagos, cambie la configuración de pagos y solicite un pago. Cada punto final actúa en la cuenta de afiliado que posee el token API.

Puntos finales 7 endpoints

Ruta base /api/v1/affiliates

Puntos finales y alcances de toque

Crear un token en la cuenta, luego Desarrolladores, y darle los alcances que los puntos finales de abajo necesitan. Una cuenta que no es un afiliado obtiene 404 de cada punto final excepto registrarse.

Punto de finalización	Ámbito de aplicación	Descripción
`GET /affiliates/me/`	`affiliates:read`	Su registro de afiliados, saldo y enlace de referencia
`GET /affiliates/referrals/`	`affiliates:read`	Cuentas que se han registrado a través de su enlace
`GET /affiliates/commissions/`	`affiliates:read`	Comisiones ganadas por los pagos de sus remisiones
`GET /affiliates/payouts/`	`affiliates:read`	Pagos solicitados y pagados
`PATCH /affiliates/settings/`	`affiliates:update`	Cambiar el método de pago, correo electrónico PayPal, cuenta de Stripe o cantidad mínima de pago `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	Solicitar un pago de su saldo una vez que alcanza su mínimo. Sólo un pago pendiente a la vez.
`POST /affiliates/signup/`	`affiliates:create`	Únete al programa de afiliados. Envía paypal_method (paypal o stripe) con paypal_email o stripe_account_id.

Las listas de referencias, comisiones y pagos están paginadas: cada respuesta tiene cuenta, siguiente, anterior y resultados. Utilice la página para moverse a través de ellos y page_size para cambiar cuántos elementos tiene cada página. Los valores de dinero se devuelven como cadenas decimales. page_size: 25 (default), 100 (max)

CONSEGUIR /api/v1/affiliates/me/

Obtenga su registro de afiliados

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Campos de respuesta

Campo	Tipo	Descripción
`status`	string	sólo afiliados activos pueden solicitar pagos.
`commission_rate`	decimal string	Comisión como porcentaje, no como fracción `20.00 = 20%`
`cookie_days`	integer	¿Cuántos días se recuerda un clic en su enlace
`balance`	decimal string	Ganadas y aún no pagadas
`total_earned` / `total_paid`	decimal string	Comisión de por vida ganada y cantidad de por vida pagada

Remisiones, comisiones y pagos

Cada elemento en resultados tiene estos campos:

Punto de finalización	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`

El estado de remisión está pendiente, activo o cancelado. El estado de la Comisión está pendiente, aprobado, pagado o cancelado. El estado de pago está pendiente, procesado, completado o fallido.

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

Códigos de estado de respuesta

200	Éxito
403	Token API no válido o falta el token o el token carece del permiso requerido
404	Esta cuenta no es una filial todavía

Especificación OpenAPI

La especificación legible por máquina para cada punto final, incluyendo estos, está abajo, y usted puede navegar interactivamente en la página de referencia de la API.

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

Límite de tarifa por cuenta: 1000 / hour

VPS.org API