ה-API של Studix לבעלי קורסים

חברו את Studix לכל מערכת חיצונית — חנות WooCommerce, אוטומציה ב-Make, CRM או כל שירות אחר. נהלו קורסים, תלמידים, גישה לקורסים, סטטיסטיקות ורשימות תפוצה ישירות מהקוד שלכם.

התחלה מהירה

כל הבקשות נשלחות אל https://cloudix.co.il/api ומאומתות בעזרת שני כותרים. צרו מפתח באזור מפתחות API בחשבון שלכם, ושלחו את הבקשה הראשונה:

cURL בדיקת חיבור
curl -X GET "https://cloudix.co.il/api/statistics/overview" \
  -H "X-API-Key: YOUR_KEY_ID" \
  -H "X-API-Secret: YOUR_SECRET" \
  -H "Accept: application/json"

אימות

האימות מתבצע באמצעות שני כותרי HTTP בכל בקשה:

כותר תיאור
X-API-Key מזהה המפתח (Key ID)
X-API-Secret הסוד. מוצג פעם אחת בלבד בעת היצירה — שמרו אותו במקום בטוח

שמרו את הסוד בצד השרת בלבד — לעולם לא בקוד צד-לקוח או במאגר ציבורי. ניתן להגביל מפתח לכתובות IP מסוימות ולבטל אותו בכל רגע מאזור מפתחות ה-API. מגבלת קצב: 1,000 בקשות לשעה למפתח.

הרשאות

לכל מפתח מוגדרות הרשאות מפורשות. בקשה לנתיב שאין לו הרשאה מתאימה תוחזר עם 403. בחרו רק את ההרשאות שהאינטגרציה שלכם באמת צריכה.

read

קריאת נתונים — קורסים, תלמידים, סטטיסטיקות ורשימות תפוצה

write

כתיבה — יצירה ועדכון של נתונים

manage_students

ניהול תלמידים — יצירה, עדכון וצפייה

manage_course_access

ניהול גישה לקורסים — הענקה, הארכה ושלילה

manage_mailing_lists

ניהול רשימות תפוצה ונרשמים

get_statistics

צפייה בסטטיסטיקות

קורסים

הרשאה נדרשת: read

GET /api/courses

רשימת כל הקורסים שלכם

GET /api/courses/{id}

פרטי קורס בודד

תלמידים

הרשאה נדרשת: read / write / manage_students

GET /api/students

רשימת התלמידים שלכם

GET /api/students/{id}

פרטי תלמיד בודד

POST /api/students

יצירת תלמיד חדש

פרמטר נדרש תיאור
name חובה שם מלא
email חובה כתובת אימייל ייחודית
password אופציונלי לפחות 8 תווים. אם לא יסופק — תיווצר סיסמה אוטומטית
phone אופציונלי מספר טלפון
city אופציונלי עיר
country אופציונלי מדינה
PUT /api/students/{id}

עדכון פרטי תלמיד

פרמטר נדרש תיאור
name אופציונלי שם מלא
email אופציונלי כתובת אימייל
phone אופציונלי מספר טלפון

גישה לקורסים

הרשאה נדרשת: write / manage_course_access

POST /api/course-access/grant

הענקת גישה לקורס. אם התלמיד לא קיים — הוא ייווצר אוטומטית ויקבל מייל עם פרטי התחברות

פרמטר נדרש תיאור
student_email חובה אימייל התלמיד
course_id חובה מזהה הקורס
access_type אופציונלי 7_days / 30_days / 90_days / 365_days / lifetime / custom
custom_expiry_date אופציונלי תאריך תפוגה מותאם (כאשר access_type=custom)
student_name אופציונלי שם התלמיד
student_phone אופציונלי טלפון התלמיד
GET /api/course-access/check

בדיקה האם לתלמיד יש גישה פעילה

פרמטר נדרש תיאור
student_id חובה מזהה התלמיד
course_id חובה מזהה הקורס
POST /api/course-access/extend

הארכת תוקף גישה קיימת

פרמטר נדרש תיאור
student_id חובה מזהה התלמיד
course_id חובה מזהה הקורס
extend_days אופציונלי מספר ימים להארכה
new_expires_at אופציונלי תאריך תפוגה חדש
POST /api/course-access/revoke

שלילת גישה לקורס

פרמטר נדרש תיאור
student_id חובה מזהה התלמיד
course_id חובה מזהה הקורס

סטטיסטיקות

הרשאה נדרשת: read / get_statistics

GET /api/statistics/overview

סיכום כללי: קורסים, תלמידים והכנסות

GET /api/statistics/courses

נתונים לכל קורס: הרשמות, התקדמות, תעודות

פרמטר נדרש תיאור
course_id אופציונלי סינון לקורס מסוים
GET /api/statistics/students

נתוני תלמידים

GET /api/statistics/revenue

נתוני הכנסות

רשימות תפוצה

הרשאה נדרשת: read / write / manage_mailing_lists

GET /api/mailing-lists

רשימת רשימות התפוצה שלכם

POST /api/mailing-lists/{list}/subscribers

הוספת נרשם לרשימה

פרמטר נדרש תיאור
email חובה אימייל הנרשם
name אופציונלי שם הנרשם
tags אופציונלי מערך תגיות
POST /api/mailing-lists/{list}/subscribers/{email}/tags

הוספת תגיות לנרשם קיים

פרמטר נדרש תיאור
tags חובה מערך תגיות

שגיאות ותשובות

כל התשובות הן JSON וכוללות שדה success. בשגיאה יתווסף message, ובשגיאת ולידציה גם errors עם פירוט לכל שדה.

קוד משמעות
200 / 201הצליח
401מפתח או סוד שגויים
403למפתח אין את ההרשאה הנדרשת, או שהמשאב אינו שייך לכם
404המשאב לא נמצא
422ולידציה נכשלה — בדקו את errors
429חריגה ממגבלת הקצב
דוגמת שגיאת ולידציה
{
  "success": false,
  "message": "Validation failed.",
  "errors": {
    "student_email": ["The student email field is required."]
  }
}

אינטגרציות מוכנות

לא חייבים לכתוב קוד. אלו חיבורים מוכנים שמשתמשים באותו API:

תוסף WordPress / WooCommerce

Studix Course Connector

מקשר מוצר בחנות לקורס ב-Studix ומעניק גישה אוטומטית מיד עם השלמת הרכישה. כולל מיפוי מוצרים, בדיקת חיבור, לוג סנכרון, שורטקודים ואינטגרציה לטפסי Elementor.

מודול ל-Make (Integromat)

אוטומציות ללא קוד

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

בקרוב

התקנת תוסף ה-WooCommerce

  1. הורידו את קובץ ה-ZIP מהכפתור למעלה.
  2. בלוח הבקרה של WordPress: תוספים ← הוסף חדש ← העלה תוסף, בחרו את הקובץ והפעילו.
  3. צרו מפתח API ב-Studix עם ההרשאות read, manage_course_access ו-manage_mailing_lists.
  4. בתפריט Studix בוורדפרס הזינו את ה-Key ID וה-Secret ולחצו בדיקת חיבור.
  5. במסך מיפוי מוצרים קשרו כל מוצר בחנות לקורס המתאים ב-Studix.

דורש WordPress 5.8 ומעלה, PHP 7.4 ומעלה ו-WooCommerce פעיל.

שאלות נפוצות

איך מתחברים ל-API של Studix?
האימות מתבצע בעזרת שני כותרי HTTP בכל בקשה: X-API-Key עם מזהה המפתח, ו-X-API-Secret עם הסוד. יוצרים את המפתח באזור "מפתחות API" בחשבון בעל הקורס. הסוד מוצג פעם אחת בלבד בעת היצירה, ולכן יש לשמור אותו מיד במקום מאובטח בצד השרת. כתובת הבסיס לכל הבקשות היא https://studix.co.il/api.
האם ניתן לחבר חנות WooCommerce ל-Studix?
כן. קיים תוסף רשמי בשם Studix Course Connector שניתן להוריד מעמוד זה ולהתקין בוורדפרס. התוסף מקשר כל מוצר בחנות לקורס ב-Studix, ומעניק לתלמיד גישה אוטומטית לקורס מיד עם השלמת הרכישה. הוא כולל גם בדיקת חיבור, לוג סנכרון, שורטקודים ואינטגרציה לטפסי Elementor. נדרשים WordPress 5.8 ומעלה, PHP 7.4 ומעלה ו-WooCommerce פעיל.
מה קורה כשמעניקים גישה לתלמיד שעדיין לא רשום במערכת?
הקריאה ל-POST /api/course-access/grant מטפלת בשני המקרים אוטומטית. אם התלמיד כבר קיים לפי כתובת האימייל, הוא פשוט נרשם לקורס ומקבל מייל אישור הרשמה. אם הוא אינו קיים, נוצר עבורו חשבון חדש עם סיסמה אוטומטית, והוא מקבל מייל "ברוכים הבאים" הכולל את פרטי ההתחברות שלו. אין צורך ליצור את התלמיד מראש בקריאה נפרדת.
מהן מגבלות הקצב של ה-API?
כל מפתח API מוגבל ל-1,000 בקשות בשעה. חריגה מהמכסה מחזירה קוד 429. בנוסף ניתן להגביל מפתח לכתובות IP מסוימות ולבטל אותו בכל רגע מאזור מפתחות ה-API, כך שמפתח שנחשף אינו מהווה סיכון מתמשך.
אילו הרשאות צריך לתת למפתח API?
ההרשאות מפורשות ונבחרות בעת יצירת המפתח: read לקריאת נתונים, write לכתיבה, manage_students לניהול תלמידים, manage_course_access להענקה ושלילה של גישה לקורסים, manage_mailing_lists לרשימות תפוצה, ו-get_statistics לסטטיסטיקות. מומלץ להעניק רק את ההרשאות שהאינטגרציה באמת צריכה. בקשה לנתיב ללא ההרשאה המתאימה מוחזרת עם קוד 403.

מוכנים להתחיל?

פתחו חשבון Studix, צרו מפתח API תוך דקה, וחברו את המערכות שלכם.