CreateYourVPN Academy
API לשותפים

API לשותפים

API צד שרת לשותפים: צרו לקוחות, העניקו מסלולים ונהלו מינויים מהאתר או מהבוט שלכם.

API לשותפים מאפשר לבנות אתר, פורטל לקוחות או בוט משלכם מעל CreateYourVPN. ה-API חושף רק לקוחות, מסלולים ומינויים; שרתים, צמתים, פאנלים ופרטי גישה לתשתית לעולם אינם מופיעים בתשובות.

המפתח מיועד לתקשורת שרת-לשרת בלבד. אל תכניסו אותו ל-JavaScript או לאפליקציה לנייד. בקשות שנראות כאילו הגיעו מדפדפן נדחות עם 403 browser_forbidden.

תחילת עבודה

  1. פתחו בלוח הבקרה את הגדרות ← API ואינטגרציות.
  2. צרו מפתח עם מינימום הרשאות והעתיקו את החלק הסודי; הוא מוצג פעם אחת בלבד.
  3. שלחו אותו כ-Authorization: Bearer cyv_live_… או כ-X-API-Key.
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

הרשאות: config:read להגדרות ולמיקומים, users:read לקריאת לקוחות ו-users:write ליצירת לקוחות ולניהול המינויים שלהם.

חוזה ציבורי

אוסף Postman הציבורי מכיל את כל נקודות הקצה, הפרמטרים, הגופים, הדוגמאות, ההרשאות וקודי השגיאה. הוא נוצר מחוזה ה-backend ולכן הוא המקור הטכני היחיד.

מגבלות: 120 בקשות בדקה לכל מפתח ו-10 בדקה עבור GET /users. הפעולות grant, rotate ו-DELETE דורשות Idempotency-Key; השתמשו שוב באותו ערך במשך 24 שעות בכל הניסיונות של אותו אירוע.

On this page