ממשק ה-API (Swagger)
השרת חושף תיעוד OpenAPI מלא (Swagger) המאפשר לראות את כל נקודות הקצה, הפרמטרים, גופי הבקשה והתגובות.
גישה לתיעוד
כאשר השרת רץ בסביבת פיתוח (או Staging), התיעוד זמין בכתובת:
http://localhost:5000/api/docs
מבנה ה-API
ה-API מחולק לפי מודולים (Tags):
- Auth: התחברות וניהול טוקנים.
- Users: ניהול משתמשים ופרופיל.
- Devices: ניהול מכשירים, פקודות וטלמטריה.
- Tfila Times: ניהול זמני תפילה.
- General Messages: הודעות מערכת.
אימות (Authentication)
רוב נקודות הקצה דורשות אימות באמצעות Bearer Token.
- בצעו Login ב-Swagger (נקודת קצה
/auth/login). - העתיקו את ה-
accessTokenשהתקבל. - לחצו על כפתור Authorize בראש עמוד ה-Swagger.
- הזינו את הטוקן בפורמט:
Bearer <Your-Token>. - כעת תוכלו לבצע בקשות מתוך הממשק.
Admin Impersonation ב-API
מנהלים יכולים לבצע קריאות בשם משתמש אחר על ידי הוספת Header:
x-customer-context:<Target-User-ID>
(אופציה זו זמינה בחלק מהנקודות דרך ה-Swagger אם הוגדרה).