CreateYourVPN Academy
Partnerské API

Partnerské API

Serverové API pro partnery: vytvářejte klienty, přidělujte tarify a spravujte předplatná z vlastního webu nebo bota.

Partnerské API umožňuje vytvořit vlastní web, klientský portál nebo bota nad CreateYourVPN. Zpřístupňuje pouze klienty, tarify a předplatná; servery, uzly, panely ani přístupové údaje infrastruktury se v odpovědích nikdy neobjeví.

Klíč je určen pouze pro komunikaci server–server. Nevkládejte ho do JavaScriptu ani mobilní aplikace. Požadavky vypadající jako z prohlížeče jsou odmítnuty chybou 403 browser_forbidden.

Začínáme

  1. V panelu otevřete Nastavení → API a integrace.
  2. Vytvořte klíč s minimálními právy a zkopírujte tajnou část; zobrazí se jen jednou.
  3. Posílejte ho jako Authorization: Bearer cyv_live_… nebo X-API-Key.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

Oprávnění: config:read pro konfiguraci a lokality, users:read pro čtení klientů a users:write pro vytváření klientů a správu předplatných.

Veřejný kontrakt

Veřejná kolekce Postman obsahuje všechny endpointy, parametry, těla, příklady, oprávnění a chybové kódy. Generuje se z kontraktu backendu a je jedinou technickou referencí.

Limity: 120 požadavků za minutu na klíč a 10 za minutu pro GET /users. grant, rotate a DELETE vyžadují Idempotency-Key; pro opakování stejné události používejte 24 hodin stejnou hodnotu.

On this page