api של מערכת schooler

api של מערכת schooler

באמצעות ה- API של סקולר תוכלו לבצע פעולות אוטומטיות ולקבל מידע ישירות ממערכת סקולר, כך למשל אפשר להוסיף תלמידים ממערכת ה-CRM שלכם לקורס או לקבל את רשימת התלמידים בקורס מסויים.


כאן אפשר למצוא את התיעוד של ה-API I שלנו.


הפעולות שאליהן יש גישה ב-API יפורטו כאן בהמשך, ועם הזמן יתווספו ויעודכנו לפי הצורך.


איך מקבלים גישה ל- API


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


  1. כדי לקבל את הקלאיינט יש לפנות אלינו לתמיכה עם בקשה לפתיחת גישה ל-API של סקולר
  2. התמיכה ישלחו לכם מייל עם פרטי קלאיינט שנוצר עבורכם
  3. אחרי שמקבלים את פרטי הקלאיינט מהתמיכה נכנסים למערכת סקולר ובתפריט הראשי למסך 'חיבורים' ומפעילים את המתג של 'חיבור API'

במסך מופיעים שני נתוני חיבור: User Id, User Secret שישמשו אתכם בקריאת הזיהוי מול ה API



החלפת 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 (המזהה). לדוגמה מבית ספר:


לדוגמה מקורס:




לקריאת המאמר המקורי במרכז הידע שלנו לחצו כאן

    • Related Articles

    • מכירת בית ספר שלם במערכת schooler

      שלבים ביצירת בית הספר מערכת schooler מאפשרת לכם להקים מספר בלתי מוגבל של בתי ספר. למה צריך בית ספר? אחד השימושים הנפוצים בו הוא כאתר קורסים, שבו הלקוחות יכולים להתרשם ממגוון הקורסים שיש לכם ולבחור בכל פעם קורס שהם רוצים לרכוש. אפשרות נפוצה נוספת היא ...
    • חיבור schooler לרב מסר החדשה

      אם אתם עובדים על המערכת החדשה של רב מסר אתם יכולים להנות מהאינטגרציה המובנית והגמישה שיצרנו בין שתי המערכות. החיבור בין מערכת רב מסר ל- Schooler הוא דו כיווני, כך שתוכלו להגדיר ייצוא אוטומטי של תלמידים שנרשמים לקורס כנמענים ברב מסר, או לייבא נמענים ...
    • סקירה כללית של מערכת schooler

      קורסים כאשר תכנסו למערכת Schooler לראשונה זה המסך שתראו לפניכם. בצד ימין נמצא התפריט הראשי ובצד שמאל הכפתור להוספת קורס חדש. אז אם אתם לא יכולים כבר לחכות פשוט תלחצו על 'ליצירת הקורס הראשון שלך' ותעקבו אחר ההוראות. אבל אם אתם קצת יותר סבלניים תישארו ...
    • מערכת השותפים

      מערכת השותפים מתאימה לקורסים מסוג 'בתשלום' בלבד מערכת השותפים המובנית ב-Schooler היא כלי מעולה לחשיפה, הפצה ומכירה של הקורס שלכם. שותפים הם אנשים שיכולים להמליץ ולשתף את הקורס שלכם כדי לחשוף אותו לקהל פוטנציאלי משותף. אתם קובעים מהו התשלום שיועבר ...
    • הגדרה ושחרור מגבלת כתובות ip לתלמידים

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