## סקירה כללית

הממשק של Institflow הוא ממשק REST מבוסס-משאבים שמכסה כל היבט בניהול בית ספר או מכון הכשרה: אנשים (תלמידים, אפוטרופוסים, צוות), לימודים (קורסים, קבוצות לימוד, רישומים, מפגשים), נוכחות, הערכה (מבחנים, ציונים, דוחות התקדמות), חיוב (חשבוניות, תשלומים), התראות, וניהול (חברי צוות, תפקידים, הגדרות, סניפים). הוא מדבר JSON בלבד, משתמש בשמות משאבים ברבים (`/students`, `/invoices`), וכל מזהה הוא UUID בגרסה 7 — ניתן למיון לפי זמן היצירה, וזה גם מה שהופך את העימוד באמצעות cursor (ראו [מוסכמות](https://docs.institflow.com/he/guides/conventions#pagination)) לזול כל כך.

מעל ממשק ה-REST קיימות שלוש דרכי אינטגרציה לבנייה על Institflow בלי אדם בלולאה: [webhooks](https://docs.institflow.com/he/webhooks) (לקבל עדכון כשמשהו קורה), [וידג'ט ההרשמה](https://docs.institflow.com/he/widget) (הטמעת טופס לכידת לידים בכל אתר), ושרת [MCP](https://docs.institflow.com/he/mcp) (לאפשר לסוכן AI להפעיל את המערכת בהרשאות אמיתיות ותחומות).

## כתובת הבסיס (Base URL)

כל נקודת קצה ברפרנס הזה יושבת תחת `/api/v1`. Institflow נמכרת באירוח עצמי בלבד, כך שאין כתובת מקור משותפת של הספק לפנות אליה: כתובת הבסיס היא **הכתובת של Institflow של המכון שלכם עצמו** — אותו מארח שאתם (או המשתמשים שלכם) כבר מתחברים אליו. אם אינכם יודעים מהי, שאלו את מנהל המערכת שלכם; לעולם אל תניחו דומיין, כולל זה שלמטה שהוא רק ממלא מקום:

```bash
https://your-institute.example/api/v1/students
```

אין תת-דומיין ייעודי לכל דייר ואין שם מארח משותף לריבוי דיירים: כל פריסת אירוח עצמי (ראו [אירוח עצמי ורישוי](https://docs.institflow.com/he/guides/self-hosting)) משרתת רק את המכון שלה, בכל מארח שעליו היא נפרסה — דומיין רגיל, דומיין מותאם שאומת, או כתובת פנימית, בהתאם לאופן שבו המכון הגדיר אותה. הדייר נגזר מאישור הגישה שאיתו ביצעתם אימות (מפתח API או JWT קשור תמיד לדייר אחד בדיוק), ולעולם לא משם המארח.

## גרסאות הממשק

גרסת הממשק נקבעת בנתיב הכתובת (`/api/v1`), לא בכותרת ולא בפרמטר שאילתה. בתוך קו גרסה אחד השינויים הם תוספתיים ותואמים לאחור: שדות בקשה אופציונליים חדשים, שדות תשובה חדשים, נקודות קצה חדשות, וערכי enum חדשים שכדאי שתהיו סובלניים כלפיהם ממילא. שינוי שובר היה יוצא כ-`/api/v2` — כרגע קיימת גרסה אחת בלבד.

## פריסה

Institflow מגיעה כחבילת Docker חד-דיירית שאתם מריצים על שרת משלכם, מוגבלת ברישיון חתום (ראו [אירוח עצמי ורישוי](https://docs.institflow.com/he/guides/self-hosting)). אין חלופה רב-דיירית שמאוחסנת אצל הספק: הנתונים והממשק של המכון שלכם נשארים על תשתית שאתם שולטים בה, והבידוד מפריסה של מכון אחר הוא בידוד פיזי, לא רק כזה שנאכף בתוכנה (ראו [ריבוי דיירים](https://docs.institflow.com/he/guides/conventions#multi-tenancy) להסבר איך הבידוד עובד בתוך הדייר שלכם עצמו).

> **אין סביבת ניסיון ציבורית**
>
> אין סביבת ניסיון ציבורית משותפת. כדי להתנסות בממשק, הריצו את חבילת האירוח העצמי מקומית — זה נותן לכם דייר אמיתי ומבודד לבנות מולו, ושום דבר שתעשו בו לא גלוי לאף אחד אחר.