CreateYourVPN Academy
API per a socis

API per a socis

API de servidor per a socis: crea clients, assigna plans i gestiona subscripcions des del teu web o bot.

L’API per a socis et permet crear el teu propi web, tauler de client o bot sobre CreateYourVPN. Només exposa clients, plans i subscripcions; els servidors, nodes, panells i credencials d’infraestructura no apareixen mai a les respostes.

La clau és només per a comunicacions servidor a servidor. No la posis en JavaScript ni en una aplicació mòbil. Les peticions que semblen provenir d’un navegador es rebutgen amb 403 browser_forbidden.

Primers passos

  1. Obre Configuració → API i integracions al tauler.
  2. Crea una clau amb els permisos mínims i copia’n el secret; només es mostra una vegada.
  3. Envia-la com Authorization: Bearer cyv_live_… o X-API-Key.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

Permisos: config:read per a configuració i ubicacions, users:read per consultar clients i users:write per crear clients i gestionar subscripcions.

Contracte públic

La col·lecció pública de Postman conté tots els endpoints, paràmetres, cossos, exemples, permisos i codis d’error. Es genera a partir del contracte del backend i és l’única referència tècnica.

Límits: 120 peticions per minut i clau, i 10 per minut per a GET /users. grant, rotate i DELETE requereixen un Idempotency-Key; reutilitza el mateix valor durant 24 hores per als reintents del mateix esdeveniment.

On this page