CreateYourVPN Academy
API partenaire

API partenaire

API serveur pour les partenaires : créez des clients, attribuez des offres et gérez les abonnements depuis votre site ou votre bot.

L’API partenaire permet de créer votre propre site, espace client ou bot sur CreateYourVPN. Elle n’expose que les clients, les offres et les abonnements ; les serveurs, nœuds, panneaux et identifiants d’infrastructure n’apparaissent jamais dans les réponses.

La clé est réservée aux échanges serveur à serveur. Ne l’intégrez jamais dans du JavaScript ou une application mobile. Les requêtes qui semblent provenir d’un navigateur sont refusées avec 403 browser_forbidden.

Bien démarrer

  1. Ouvrez Paramètres → API et intégrations dans le tableau de bord.
  2. Créez une clé avec les droits minimaux et copiez son secret ; il n’est affiché qu’une fois.
  3. Envoyez-la via Authorization: Bearer cyv_live_… ou X-API-Key.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

Droits disponibles : config:read pour la configuration et les emplacements, users:read pour consulter les clients et users:write pour les créer et gérer leurs abonnements.

Contrat public

La collection Postman publique contient tous les endpoints, paramètres, corps, exemples, droits et codes d’erreur. Elle est générée depuis le contrat du backend et constitue donc l’unique référence technique.

Limites : 120 requêtes par minute et par clé, et 10 par minute pour GET /users. grant, rotate et DELETE exigent un Idempotency-Key ; réutilisez la même valeur pendant 24 heures pour chaque nouvelle tentative d’un même événement.

On this page