טוקן API

טוקן API (token) מאפשר לתוכנה חיצונית לקרוא לנקודות הגישה של ה-API של Omniscol בשם בית הספר, לקריאה, ולכתיבה אם נבחרו נקודות גישה לכתיבה.

זו יכולת עוצמתית, ולכן יש להשתמש בה בזהירות.

יצירה

טוקן נוצר במסך שיתוף (ייבוא/ייצוא > שיתוף). יש להזין:

  • מפתח (נוצר ב-Omniscol, עם תווית ותפוגה אפשרית; ניתן לשנות את תאריך התפוגה שלו מאוחר יותר),
  • היקף: רשימת נקודות הגישה של ה-API שהטוקן יוכל לקרוא להן (תנו רק את מה שנחוץ בהחלט),
  • אפשרות להגדיר תפוגה לטוקן. תאריך זה נכתב ב-JWT שנוצר ואי אפשר לשנות אותו אחר כך.

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

שימוש

הטוקן מועבר בכותרת HTTP Authorization: Bearer <token>, או (פחות מומלץ בסביבת ייצור) בכתובת האתר באמצעות ?auth=<token>.

שיטות עבודה מומלצות

  • מפתח אחד לכל אינטגרציה — מאפשר ביטול עצמאי.
  • היקף מינימלי — סמנו רק את ה-API הנחוצים, לא הכול כברירת מחדל.
  • תפוגה ברמה הנכונה — השתמשו בתפוגה של המפתח כדי לנהל אינטגרציה לאורך זמן; השתמשו בתפוגה של הטוקן לגישה זמנית שאי אפשר לשנות.
  • החלפה תקופתית — צרו את המפתח מחדש אחת ל-6 עד 12 חודשים.
  • לא ב-Git — הטוקן לא צריך להגיע לניהול גרסאות במאגר ציבורי. השתמשו במשתני הסביבה של השרת שלכם.

ההבדל מ-OIDC / SSO

כדי לחבר משתמשים אמיתיים עם הזהות המוסדית שלהם, השתמשו בדף OIDC / SSO. טוקן API מיועד לאינטגרציות טכניות בין שרתים, ולא להתחברות היומיומית של המשתמשים.

ראו גם