מה זה ומתי צריך את זה
ה-API להוספת משמרת פתוחה יוצר משמרת פתוחה בסידור העבודה ישירות ממערכת חיצונית, בלי להזין אותה ידנית במסך "תכנון סידור עבודה". המשמרת נוצרת בכל אחד מהסניפים שציינתם, והעובדים שהתפקיד שלהם מופיע במשמרת יכולים להשתבץ אליה.
מה המדריך הזה כולל
המדריך כולל: מי יכול לקרוא ל-API, מה צריך כדי שזה יעבוד, כתובת וכל הפרמטרים, יצירת משמרת חד־פעמית ויצירת משמרת קבועה, דוגמת בקשה ותשובה, איך המשמרת מופיעה באתר, הודעות שגיאה, שאלות נפוצות ופתרון בעיות, מקרא, מילון מונחים וסיכום. נושאים קרובים שיש להם מדריך משלהם: "השתבצות למשמרות פתוחות", "טעינת משמרות פתוחות באמצעות קובץ אקסל", "API להוספת עובד חדש" ו"הוספת עובד JSON API".
🎬 סרטון הסבר קצר
הסרטון מראה איך מוסיפים משמרת פתוחה דרך ה-API: בדיקת משתמש מנהל, סניפים ותפקידים, שליחת בקשה לכתובת ה-API, הוספת הפרמטרים החובה, הוספת פרמטרים למשמרת חד־פעמית או קבועה, בדיקת התשובה ובדיקת המשמרת במסך "תכנון סידור עבודה".
מדריך מקוצר
ודאו שיש לכם משתמש מנהל בחברה (שם משתמש וסיסמה), ושהסניפים והתפקידים כבר קיימים במערכת.
שלחו בקשה לכתובת https://412.co.il/index.php/api/addOpenShift.
הוסיפו את הפרמטרים החובה: u, p, name, store, started_at, ended_at, role, role_count.
למשמרת חד־פעמית הוסיפו open_at (תאריך). למשמרת קבועה הוסיפו is_fixed=1 וגם week_at, fixed_started, fixed_ended.
בדקו שהתשובה היא {"status":true}.
היכנסו ל"תכנון סידור עבודה" ובדקו שהמשמרת מופיעה בשורה "משמרות פתוחות".
1. מי יכול לעשות מה
ה-API מזהה משתמש לפי שם משתמש וסיסמה שנשלחים בבקשה.
סוג משתמש | מה אפשר |
מנהל החברה / משתמש מנהל | יכול לקרוא ל-API. המשמרת נוצרת בחברה של המשתמש בלבד, ומחפשים בה רק סניפים ותפקידים של אותה חברה. |
עובד (משתמש מסוג עובד) | אינו יכול להשתמש ב-API. מתקבלת התשובה "no authenticated." (עם נקודה בסוף). |
2. מה צריך כדי שזה יעבוד
משתמש מנהל בחברה, עם שם משתמש וסיסמה.
מודול סידור העבודה (משמרות) פעיל בחברה.
הסניפים שתשלחו ב-store קיימים בחברה, והשם זהה בדיוק לשם בחברה.
התפקידים שתשלחו ב-role קיימים בחברה, והשם זהה בדיוק לשם התפקיד.
3. כתובת ושיטת שליחה
הכתובת: https://412.co.il/index.php/api/addOpenShift. הפרמטרים נקראים משורת הכתובת או מגוף הבקשה, ולכן אפשר לשלוח אותם בבקשת GET או POST. מומלץ POST, כדי שהסיסמה לא תופיע בכתובת.
4. הפרמטרים
# | שם | חובה? | תיאור | דוגמה |
1 | u | חובה | שם משתמש של מנהל | admin_user |
2 | p | חובה | סיסמת המנהל | הסיסמה של המשתמש |
3 | name | חובה | שם המשמרת הפתוחה | משמרת ערב |
4 | store | חובה | שמות סניפים מופרדים בפסיק. לכל סניף שנמצא נוצרת משמרת נפרדת. | סניף צפון,סניף דרום |
5 | started_at | חובה | שעת התחלה | 13:00 |
6 | ended_at | חובה | שעת סיום | 14:00 |
7 | role | חובה | שמות תפקידים מופרדים בפסיק | קופאי,מלצר |
8 | role_count | חובה | כמות העובדים לכל תפקיד, לפי סדר התפקידים (ראו הערה בהמשך) | 34 |
9 | location | רשות | מיקום המשמרת (מוצג לעובד בפרטי המשמרת). מומלץ לשלוח את הפרמטר גם כשהוא ריק. | תל אביב, רחוב 12 |
10 | note | רשות | הערה לעובד. מומלץ לשלוח את הפרמטר גם כשהוא ריק. | נא להגיע 10 דקות לפני |
11 | is_fixed | רשות | שליחת הפרמטר הופכת את המשמרת לקבועה. לשימוש: is_fixed=1. למשמרת חד־פעמית אל תשלחו אותו כלל. | 1 |
12 | open_at | חובה כשאין is_fixed | תאריך המשמרת, בפורמט שנה-חודש-יום | 2026-11-01 |
13 | week_at | חובה כש-is_fixed=1 | ימי השבוע שבהם המשמרת חוזרת, מופרדים בפסיק (1 = שני, 2 = שלישי) | 1,2 |
14 | fixed_started | חובה כש-is_fixed=1 | תאריך תחילת החזרתיות | 2026-11-01 |
15 | fixed_ended | חובה כש-is_fixed=1 | תאריך סיום החזרתיות | 2026-12-01 |
16 | color | רשות | צבע המשמרת. בלי הפרמטר נבחר צבע אקראי. | #3366ff |
הערה על role_count: הכמות של כל תפקיד נקראת לפי המיקום שלו בערך ששלחתם, תו אחד לכל תפקיד. לכן שלחו ספרה אחת לכל תפקיד, ברצף וללא פסיקים. למשל לשני תפקידים (3 עובדים לראשון ו-4 לשני) שלחו 34. כמות של שתי ספרות ומעלה אינה נתמכת בדרך הזו.
5. משמרת חד־פעמית ומשמרת קבועה
משמרת חד־פעמית
שלחו open_at עם התאריך, ואל תשלחו את is_fixed. המשמרת נוצרת בתאריך הזה.
משמרת קבועה
שלחו is_fixed=1 יחד עם week_at, fixed_started ו-fixed_ended. המשמרת חוזרת בימים שציינתם בטווח התאריכים. אין צורך ב-open_at. אם חסר אחד משלושת הפרמטרים, מתקבלת השגיאה required_value:static_setting_value.
חשוב: הקיום של הפרמטר is_fixed הוא שקובע שהמשמרת קבועה, גם אם ערכו 0. למשמרת חד־פעמית השמיטו אותו לגמרי.
6. דוגמת בקשה ותשובה
בקשה ליצירת משמרת חד־פעמית בשני סניפים עם שני תפקידים (3 קופאים ו-4 מלצרים):
curl -X POST "https://412.co.il/index.php/api/addOpenShift" \ -d "u=admin_user" \ -d "p=YOUR_PASSWORD" \ -d "name=משמרת ערב" \ -d "store=סניף צפון,סניף דרום" \ -d "started_at=13:00" \ -d "ended_at=14:00" \ -d "role=קופאי,מלצר" \ -d "role_count=34" \ -d "location=תל אביב" \ -d "note=" \ -d "open_at=2026-11-01"
תשובה מוצלחת:
{"status":true}תשובת כישלון:
{"status":false,"msg":"incorrect_store_name"}7. איך המשמרת מופיעה במערכת
אחרי יצירה מוצלחת המשמרת מופיעה במסך "תכנון סידור עבודה" בשורה "משמרות פתוחות" (אם השורה מוסתרת, כבו את המתג "הסתר שורה של משמרת פתוחה"), ועובדים עם תפקיד מתאים רואים אותה ב"הגשת העדפות שיבוץ" באתר ובלשונית "משמרות" ← "משמרות פתוחות" באפליקציה. פרטים על השתבצות ואישור בקשות מופיעים במדריך "השתבצות למשמרות פתוחות".
8. מה קורה כשחלק מהשמות לא נכונים
אם חלק מהסניפים לא נמצאו, המשמרת נוצרת רק בסניפים שנמצאו, והתשובה היא עדיין {"status":true}.
אם חלק מהתפקידים לא נמצאו, המשמרת נוצרת רק עם התפקידים שנמצאו.
אם אף סניף לא נמצא – השגיאה incorrect_store_name. אם אף תפקיד לא נמצא – השגיאה incorrect_role_name. במקרים האלה לא נוצרת משמרת.
הודעות שגיאה
התשובה היא תמיד JSON. כשהפעולה נכשלה, status הוא false, ו-msg מכיל את הסיבה.
msg | מה זה אומר | מה לעשות |
no authenticated | לא נשלחו u ו-p | שלחו שם משתמש וסיסמה |
no authenticated. | שם משתמש או סיסמה שגויים, או שהמשתמש הוא עובד ולא מנהל | בדקו את הפרטים והשתמשו במשתמש מנהל |
invalid_param | חסר אחד מ-store, name, started_at, ended_at, role, role_count | הוסיפו את הפרמטר החסר |
incorrect_store_name | אף שם סניף לא נמצא בחברה | בדקו איות ושלחו שם סניף כפי שהוא מופיע במערכת |
required_value:open_at | לא נשלח is_fixed וגם חסר open_at | שלחו open_at, או הגדירו משמרת קבועה |
required_value:static_setting_value | נשלח is_fixed אבל חסר week_at, fixed_started או fixed_ended | שלחו את שלושתם |
incorrect_role_name | אף שם תפקיד לא נמצא בחברה | בדקו איות ושלחו שם תפקיד כפי שהוא מופיע במערכת |
שאלות נפוצות ופתרון בעיות
❓ קיבלתי "no authenticated." ואני בטוח שהסיסמה נכונה
ה-API פתוח למשתמשי מנהל בלבד. משתמש מסוג עובד אינו מורשה. נסו עם משתמש מנהל החברה.
❓ קיבלתי "invalid_param"
חסר אחד משמונת פרמטרי החובה: store, name, started_at, ended_at, role, role_count (וגם u ו-p). בדקו ששמות הפרמטרים באותיות קטנות ושהערך לא ריק.
❓ קיבלתי "incorrect_store_name"
שם הסניף ב-store לא זהה לשם בחברה. בדקו איות, רווחים ושימוש בפסיק להפרדה בין סניפים.
❓ קיבלתי "incorrect_role_name"
אף תפקיד לא נמצא. שלחו את שם התפקיד בדיוק כפי שהוא מוגדר בחברה.
❓ קיבלתי "required_value:open_at"
לא שלחתם is_fixed ולא שלחתם open_at. למשמרת חד־פעמית הוסיפו open_at, למשמרת קבועה שלחו is_fixed=1.
❓ קיבלתי "required_value:static_setting_value"
שלחתם is_fixed אבל חסר week_at, fixed_started או fixed_ended. שלחו את שלושתם.
❓ רציתי משמרת חד־פעמית, שלחתי is_fixed=0 והמשמרת נוצרה כקבועה (או קיבלתי שגיאה)
עצם הקיום של הפרמטר מסמן משמרת קבועה, גם עם הערך 0. השמיטו את is_fixed לגמרי ושלחו open_at.
❓ קיבלתי status:true אבל המשמרת נוצרה רק בחלק מהסניפים
סניף שלא נמצא מדלגים עליו בלי הודעה. בדקו את איות כל סניף ב-store.
❓ קיבלתי status:true אבל חסר תפקיד במשמרת
תפקיד שלא נמצא מדלגים עליו בלי הודעה. בדקו את איות כל תפקיד ב-role.
❓ הכמות של התפקיד השני יצאה לא נכונה
הכמות נקראת תו אחד לכל תפקיד לפי המיקום שלו. שלחו ספרות רצופות בלי פסיקים (למשל 34 ולא 3,4). כמות של שתי ספרות אינה נתמכת. אפשר לתקן את הכמות אחר כך בעריכת המשמרת ב"תכנון סידור עבודה".
❓ יצרתי משמרת ולא רואה אותה
היכנסו ל"תכנון סידור עבודה" ובדקו את השבוע הנכון ואת השורה "משמרות פתוחות". אם השורה מוסתרת, כבו את המתג "הסתר שורה של משמרת פתוחה". משמרת חד־פעמית מופיעה בתאריך open_at.
❓ העובדים לא רואים את המשמרת
העובד רואה משמרת פתוחה רק אם הוא משויך לסידור העבודה של המשמרת ויש לו תפקיד שמופיע בה. פרטים במדריך "השתבצות למשמרות פתוחות".
❓ יצרתי משמרת בטעות, איך מוחקים או משנים?
ה-API רק מוסיף משמרות. למחיקה או עריכה היכנסו ל"תכנון סידור עבודה" ובכרטיס המשמרת בשורה "משמרות פתוחות" לחצו על סמל המחיקה או העריכה.
❓ שלחתי את אותה בקשה פעמיים
נוצרות שתי משמרות, ה-API לא בודק כפילויות. מחקו את המשמרת המיותרת במסך "תכנון סידור עבודה".
❓ איך נקבע מה צבע המשמרת?
אם לא שולחים color, נבחר צבע אקראי. אפשר לשנות את הצבע בעריכת המשמרת.
❓ אפשר להוסיף הרבה משמרות בבת אחת?
אפשר לשלוח בקשה לכמה סניפים בו־זמנית דרך store, או לטעון קובץ אקסל לפי המדריך "טעינת משמרות פתוחות באמצעות קובץ אקסל".
מקרא סמלים וצבעים
ערך | משמעות |
{"status":true} | המשמרת נוצרה |
{"status":false,"msg":"..."} | הפעולה נכשלה, ב-msg הסיבה |
מילון מונחים
משמרת פתוחה: משמרת שמפורסמת לעובדים בלי שיבוץ מראש.
משמרת קבועה: משמרת שחוזרת בימי שבוע שנקבעו בטווח תאריכים.
סניף (store): הסניף שבו נוצרת המשמרת. לכל סניף נוצרת משמרת נפרדת.
תפקיד (role): התפקיד שנדרש במשמרת.
role_count: כמות העובדים לכל תפקיד.
סיכום מהיר
מה רוצים לעשות | איפה | מה זה משנה |
ליצור משמרת חד־פעמית | api/addOpenShift עם open_at | נוצרת משמרת בתאריך שצוין, בכל סניף שנמצא |
ליצור משמרת קבועה | api/addOpenShift עם is_fixed=1, week_at, fixed_started, fixed_ended | המשמרת חוזרת בימים שצוינו בטווח |
לראות את המשמרת | תכנון סידור עבודה ← שורה "משמרות פתוחות" | אפשר לערוך, למחוק ולאשר בקשות |
מאמרים קשורים
השתבצות למשמרות פתוחות
טעינת משמרות פתוחות באמצעות קובץ אקסל
API להוספת עובד חדש
הוספת עובד JSON API