CreateYourVPN Academy
API partnerskie

API partnerskie

Serwerowe API dla partnerów: twórz klientów, przyznawaj plany i zarządzaj subskrypcjami z własnej strony lub bota.

API partnerskie pozwala zbudować własną stronę, panel klienta lub bota na bazie CreateYourVPN. Udostępnia tylko klientów, plany i subskrypcje; serwery, węzły, panele i dane dostępowe infrastruktury nigdy nie trafiają do odpowiedzi.

Klucz służy wyłącznie do komunikacji serwer–serwer. Nigdy nie umieszczaj go w JavaScript ani aplikacji mobilnej. Żądania wyglądające na przeglądarkowe są odrzucane kodem 403 browser_forbidden.

Pierwsze kroki

  1. Otwórz w panelu Ustawienia → API i integracje.
  2. Utwórz klucz z minimalnymi uprawnieniami i skopiuj sekret; zostanie pokazany tylko raz.
  3. Wyślij go jako Authorization: Bearer cyv_live_… lub X-API-Key.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

Uprawnienia: config:read do konfiguracji i lokalizacji, users:read do odczytu klientów oraz users:write do tworzenia klientów i zarządzania subskrypcjami.

Publiczny kontrakt

Publiczna kolekcja Postman zawiera wszystkie endpointy, parametry, body, przykłady, uprawnienia i kody błędów. Jest generowana z kontraktu backendu i stanowi jedyne źródło dokumentacji technicznej.

Limity: 120 żądań na minutę na klucz i 10 na minutę dla GET /users. grant, rotate i DELETE wymagają Idempotency-Key; przez 24 godziny używaj tej samej wartości dla ponowień tego samego zdarzenia.

On this page