api של מערכת schooler
באמצעות ה- API של סקולר תוכלו לבצע פעולות אוטומטיות ולקבל מידע ישירות ממערכת סקולר, כך למשל אפשר להוסיף תלמידים ממערכת ה-CRM שלכם לקורס או לקבל את רשימת התלמידים בקורס מסויים.
כאן אפשר למצוא את התיעוד של ה-API I שלנו.
הפעולות שאליהן יש גישה ב-API יפורטו כאן בהמשך, ועם הזמן יתווספו ויעודכנו לפי הצורך.
חיבור עצמי ל-API של סקולר
עד היום, כדי לקבל גישה ל-API של Schooler ולהפיק מפתחות התחברות, היה צורך בפנייה יזומה לצוות התמיכה שלנו.
הטמענו מערכת בשירות עצמי (Self Service) המאפשרת לכם להפעיל את הגישה ל-API, להפיק את מפתחות האבטחה שלכם באופן עצמאי ולהתחיל לעבוד באופן מיידי.
החיבור מאפשר אינטגרציה עם מערכות חיצוניות וצד שלישי, ונדרש גם עבור חיבורים מתקדמים כמו ה-MCP של Claude וכלי AI שונים.
1. כניסה למסך הגדרות ה-API
- התחברו לחשבון ה-Schooler שלכם.
- נווטו לתפריט הגדרות (או הגדרות מתקדמות/אינטגרציות בחשבון שלכם).
- חפשו את האזור הייעודי שנקרא "חיבור API".
- במסך זה תראו כפתור הפעלה (טוגל) המסומן כ-"פעיל".
- העבירו את הכפתור למצב פעיל (צבע תכלת). הפעלה זו מאשרת את השימוש ב-API ומציגה את פרטי ההתחברות שלכם.
- לאחר הפעלת הטוגל, יופיעו בפניכם שני נתונים קריטיים לצורך החיבור:
User ID: כתובת האימייל המזהה של החשבון שלכם. לחצו על כפתור "העתק" הכחול לצד השדה כדי להעתיק אותה במדויק. - User Key: מפתח האבטחה הייחודי שלכם. לחצו על כפתור "העתק" הכחול לצד השדה כדי לשמור אותו בלוח.
החלפת User Secret
אם יש צורך, אפשר להחליף קוד User Secret בלחיצה על הכפתור בשם זה במסך 'חיבורים', אבל כדאי לדעת ולשים לב:
החלפה כזו של קוד היא פעולה עם משמעות נרחבת: למעשה היא תגרום לכל החיבורים והפונקציות שמשתמשות בקוד הקודם להפסיק לעבוד, ויהיה צורך להגדיר את הפעולות האלו מחדש.
הסיבה לבצע פעולה כזאת יכולה להיות אבטחת מידע - למשל מניעת גישה ממישהו שכבר לא עובד בארגון.
פונקציות ה-API
אלו הפונקציות שמערכת סקולר חושפת כיום באמצעות ה-API. פירוט טכני נוסף להגדרה והפעלה של הפונקציות תוכלו למצוא במסמך תיעוד ה-API של סקולר, שנמצא כאן
| פונקציה | תיאור |
| Get list of courses | קבלת רשימה של כל הקורסים בחשבון (גם קורסים ששייכים לבית-ספר, וגם קורסים עצמאיים) |
| Get List of schools | קבלת רשימה של כל בתי הספר שמוגדרים בחשבון |
| Get List of Students in course | קבלת רשימה של כל התלמידים בקורס מסויים |
| Get List of students in school | קבלת רשימה של כל התלמידים בבית-ספר מסויים |
| Search a student (by id, email or phone) | חיפוש תלמידים לפי מזהה תלמיד, מייל או טלפון |
| Get list of Lessons in a course | קבלת כל השיעורים בקורס מסויים |
| Create a new student in a course | יצירת תלמיד/ים חדש/ים בקורס |
| Create a new student in a School | יצירת תלמיד/ים חדש/ים בבית-ספר |
| Update student in a course | עידכון פרטי תלמיד בקורס |
| Update student in School | עדכון פרטי תלמיד בבית-ספר |
| Delete student from a course or a school | מחיקת תלמיד מקורס או בית-ספר |
מזהה קורס ובית ספר
כדי לקבל מידע על תלמידים בקורס מסויים או לעדכן תלמיד בקורס או בית ספר צריך לבצע קריאה לפי מזהה הקורס או הבית ספר
את המזהה הזה אפשר למצוא במקומות הבאים
- אפשר לבצע קריאת Get לקבלת רשימה של כל הקורסים בחשבון, וקריאת GET לקבלת רשימה של בתי ספר. הקריאה מתועדת בדוקומנטציה של ה- API
- במסך עריכת הקורס (כאשר הקורס במצב פעיל) לוחצים על האייקון של קישור הקורס ושם אפשר להעתיק את ה- ID (מזהה) הקורס
- בכניסה להגדרות כל קורס או בית ספר- בחלק בעליון של העמוד יופיע ה ID (המזהה). לדוגמה מבית ספר:
לדוגמה מקורס:
לקריאת המאמר המקורי במרכז הידע שלנו לחצו כאן