באמצעות ה- API של סקולר תוכלו לבצע פעולות אוטומטיות וקבל מידע ישירות ממערכת סקולר, כך למשל אפשר להוסיף תלמידים ממערכת ה-CRM שלכם לקורס או לקבל את רשימת התלמידים בקורס מסויים.
כאן אפשר למצוא את התיעוד של ה-API שלנו.
הפעולות שאליהן יש גישה ב-API יפורטו כאן בהמשך, ועם הזמן יתווספו ויעודכנו לפי הצורך.
איך מקבלים גישה ל- API
כדי להזדהות מול ה API של סקולר יש צורך ביצירת קלאיינט וגם בטוקן ו- ID של החשבון הספציפי שמעוניינים לחבר.
- כדי לקבל את הקלאיינט יש לפנות אלינו לתמיכה עם בקשה לפתיחת גישה ל-API של סקולר
- התמיכה ישלחו לכם מייל עם פרטי קלאיינט שנוצר עבורכם
- אחרי שמקבלים את פרטי הקלאיינט מהתמיכה נכנסים למערכת סקולר ובתפריט הראשי למסך "חיבורים" ומפעילים את המתג של "חיבור API"
במסך מופיעים שני נתוני חיבור: User Id, User Secret שישמשו אותכם בקריאת הזיהוי מול ה API
החלפת User Secret
אם יש צורך, אפשר להחליף קוד User Secret בלחיצה על הכפתור בשם זה במסך "חיבורים", אבל כדאי לדעת ולשים לב:
החלפה כזו של קוד היא פעולה עם משמעות נרחבת: למעשה היא תגרום לכל החיבורים והפונקציות שמשתמשות בקוד הקודם להפסיק לעבוד, ויהיה צורך להגדיר את הפעולות האלו מחדש.
הסיבה לבצע פעולה כזאת יכולה להיות טבטחת מידע – למשל מניעת גישה ממישהו שכבר לא עובד באירגון.
פונקציות ה-API
מעבר לדוקומנטציה של Schooler 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 | מחיקת תלמיד מקורס או בית-ספר |