מסמך זה הודפס מאתר צייטק מהעמוד הזה:

API

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

פעולות אפשריות ב API של מערכת צייטק:
  • בדיקת מצב הערוצים - כדי לקבל מידע על מצבם הנוכחי של הערוצים במערכת.
  • שינוי מצב ערוץ - כדי לשנות את מצב הערוץ. לדוגמה: להדליק או לכבות את הערוץ.
  • שינוי מצב ערוץ לזמן - כדי לשנות את מצב הערוץ לזמן קצוב. לדוגמה: להדליק או לכבות את הערוץ ל 10 דקות.
  • שינוי מצב קבוצה - כדי לשנות את את מצב הקבוצה. לדוגמה: להדליק או לכבות את הערוצים בקבוצה.
  • שינוי מצב קבוצה לזמן - כדי לשנות את מצב הערוצים בקבוצה לזמן קצוב. לדוגמה: להדליק או לכבות את הערוצים בקבוצה ל 10 דקות.
דוגמאות לשימושים נפוצים ב API:
  • תלמידים יכולים להפעיל מכונות כביסה וייבוש לאחר ביצוע תשלום במערכת חיצונית
  • הדלת בכניסה לאירוע תפתח למשתמשים אחרי ביצוע תשלום
  • הפעלת מזגנים ותאורה בבית כנסת על ידי מתפללים מורשים
  • פתיחת שער חשמלי באמצעות מערכת קולית עם מספר ייחודי לכל שער
תשובות בדפדפן:
לאחר קבלת פרטי ה-API של המערכת שלכם, תוכלו להשתמש בהם כדי לשלוח פקודות אל הצייטק.
התגובות המתקבלות מדפדפן/קונסול
קוד 200: פקודת ה-API נשלחה בהצלחה אל הצייטק.
קוד 404: כתובת ה-API שנשלחה אל הצייטק לא תקינה.
פתרון תקלות ב API:
אם קיבלתם תשובה 404 - וודאו כי הכתובת נכונה, ובמידת הצורך פנו אלינו.
אם קיבלתם תשובה 200 (הצלחה) ובכל זאת מצב הערוץ לא שונה, ניתן לבדוק בקובץ לוג את הסיבה, כדלהלן:
הרישום בקובץ לוג: הפתרון:
"שגיאה" - "ההפעלה מרחוק מושבתת"
  1. יש לפנות אלינו כדי שנפעיל את ה API עבור הצייטק שלכם.
  2. לוודא שנשלח מספר ערוץ (channel) הקיים בצייטק.
"שגיאה - בעיה בהגדרת מצב עבור ערוץ ..." יש לשלוח מצב (state) תקין המתאים למצב האפשרי בערוץ.
"שגיאה - טוקן שגוי" יש לשלוח את הטוקן (token) הנכון בבקשה.
כיצד אוכל לקבל את פרטי ה API של המערכת שלי?
ה API הוא ייחודי לכל מערכת צייטק ומכיל בתוכו מספר משתנים.
כדי לקבל את ה-API עבור המערכת שלכם, אנא פנו אלינו ונשמח לעזור.

התחברות ושליטה