מה זה ומתי צריך את זה

הקריאה getEmp מחזירה בפורמט JSON את רשימת העובדים של החברה שלכם (שם, תפקידים, מחלקה, מספר עובד, סטטוס ועוד). היא מתאימה כשרוצים למשוך את נתוני העובדים למערכת חיצונית, למשל מערכת שכר או משאבי אנוש.

מה המדריך הזה כולל

המדריך כולל: מקוצר, מי יכול להשתמש ומה צריך כדי שזה יעבוד, כתובת ופרמטרים, השדות שחוזרים (כולל ערכי הסטטוס), דוגמאות לבקשה ולתשובה, הודעות שגיאה, שאלות נפוצות ופתרון בעיות, מילון מונחים וסיכום מהיר. קריאות API אחרות מוסברות במדריכים נפרדים המופיעים ב"מאמרים קשורים".

🎬 סרטון הסבר קצר

הסרטון מראה איך מושכים את רשימת העובדים: בדיקה שהשירות מופעל ושיש משתמש עם הרשאת ניהול, שליחת בקשה לכתובת הקריאה עם שם משתמש וסיסמה, בדיקה שהסטטוס בתשובה הוא true, קריאת הרשימה מהשדה msg וסינון לפי סטטוס העובד.

סרטון הסבר: api לקבלת רשימת עובדים. ודאו שהשירות מופעל, שלחו בקשה לכתובת, בדקו את הסטטוס בתשובה, קראו את רשימת העובדים, סננו לפי סטטוס עובד

מדריך מקוצר

ודאו שהשירות מופעל בחברה שלכם ושיש לכם משתמש בעל הרשאת ניהול.
שלחו בקשה לכתובת https://412.co.il/api/getEmp עם הפרמטרים u (שם משתמש) ו-p (סיסמה).
בדקו ש-status בתשובה הוא true.
קראו את רשימת העובדים מהשדה msg.
סננו לפי השדה status של כל עובד (1 פעיל, 2 לא פעיל, 3 טיוטה) לפי הצורך.

1. מי יכול להשתמש

הקריאה מתבצעת עם שם משתמש וסיסמה של משתמש במערכת, והיא מחזירה את עובדי החברה שאליה שייך המשתמש.

מי	מה אפשרי
מנהל מערכת / משתמש עם הרשאת ניהול	יכול לקרוא ל-API ומקבל את כל עובדי החברה.
עובד רגיל (סוג המשתמש הנמוך ביותר)	הקריאה נדחית בהודעה `no authenticated.`

המשתמש חייב להיות פעיל, העובד שלו לא מחוק, והסטטוס שלו "פעיל". הרשימה שחוזרת היא תמיד של כל החברה, ללא סינון לפי מחלקה.

2. מה צריך כדי שזה יעבוד

שם משתמש וסיסמה נכונים של משתמש בעל הרשאת ניהול.
שירות קבלת העובדים צריך להיות מופעל בחבילה של החברה. אם הוא לא מופעל מתקבלת השגיאה no_have_permission. לשם הפעלה פנו לתמיכה.

3. כתובת ופרמטרים

כתובת: https://412.co.il/api/getEmp

פרמטר	תיאור	סוג	דוגמה
`u`	שם משתמש	מחרוזת	`test`
`p`	סיסמה	מחרוזת	`123456`

הפרמטרים נקראים מהבקשה, ולכן אפשר לשלוח אותם ב-GET או ב-POST. מומלץ לשלוח ב-POST, כדי שהסיסמה לא תופיע בכתובת (בכתובת היא עלולה להישמר ביומני שרתים ובהיסטוריית דפדפן).

4. מה חוזר בתשובה

התשובה היא JSON עם שני שדות:

שדה	תיאור
`status`	`true` בהצלחה, `false` בכישלון.
`msg`	בהצלחה: מערך עובדים. בכישלון: קוד שגיאה (מחרוזת).

השדות של כל עובד

שדה	תיאור
`empname`	שם פרטי ושם משפחה
`nickname`	כינוי (יכול להיות ריק)
`SalaryNo`	מספר שכר
`role`	מערך תפקידים; בכל פריט `role_name` (שם התפקיד) ו-`role_id` (מזהה). מוצגים רק תפקידים פעילים.
`CellPhone`, `Email`	טלפון סלולרי ודוא"ל
`birthdate`	תאריך לידה
`dworkStart`, `dworkEnd`	תאריך תחילת עבודה ותאריך סיום עבודה
`DeptName`, `DeptCode`	שם וקוד המחלקה
`EmpNo`	מספר עובד
`salary_type`, `salary`	סוג שכר ושכר
`status` (מופיע בתשובה כ-`Status`)	1 = פעיל, 2 = לא פעיל, 3 = טיוטה
`UserTypeDescr`	תיאור סוג המשתמש

הרשימה כוללת גם עובדים לא פעילים ועובדים בטיוטה (הבדילו ביניהם לפי הסטטוס). עובדים שנמחקו אינם מופיעים.

5. דוגמאות

בקשת POST לדוגמה:

POST /api/getEmp HTTP/1.1Host: 412.co.ilu=test&p=123456

בקשת GET לדוגמה (פחות מומלץ):

https://412.co.il/api/getEmp?u=test&p=123456

תשובה מוצלחת (מקוצרת):

{ "status": true, "msg": [ { "empname": "admin 1", "nickname": null,  "role": [ { "role_name": "driver", "role_id": 1440 } ],  "CellPhone": "", "Email": "", "birthdate": null,  "dworkStart": null, "dworkEnd": null,  "DeptName": "Dept1", "DeptCode": "1", "EmpNo": "1222", "Status": 1 } ] }

תשובה בכישלון:

{ "status": false, "msg": "no authenticated." }

הודעות שגיאה

הודעה (`msg`)	משמעות	מה לעשות
`no authenticated`	לא נשלחו הפרמטרים `u` ו-`p` בכלל.	שלחו את שני הפרמטרים.
`no authenticated.` (עם נקודה)	שם משתמש או סיסמה שגויים, משתמש לא פעיל, או משתמש מסוג עובד רגיל.	בדקו פרטי כניסה, שהמשתמש פעיל ושיש לו הרשאת ניהול.
`invalid_param`	למשתמש אין חברה מזוהה.	פנו לתמיכה.
`no_have_permission`	השירות אינו מופעל בחבילה של החברה.	פנו לתמיכה להפעלה.

שאלות נפוצות ופתרון בעיות

❓ קיבלתי "no authenticated." למרות שהסיסמה נכונה

בדקו שהמשתמש פעיל, שהעובד שלו בסטטוס "פעיל" ולא נמחק, ושזה לא משתמש מסוג עובד רגיל.

❓ קיבלתי "no authenticated" בלי נקודה

הפרמטרים לא הגיעו. בדקו ששמות הפרמטרים הם u ו-p באותיות קטנות.

❓ קיבלתי "no_have_permission"

השירות לא מופעל בחברה. פנו לתמיכה.

❓ הרשימה ריקה

אם status הוא true ו-msg ריק, אין בחברה עובדים (שלא נמחקו).

❓ עובד מסוים לא מופיע

עובד שנמחק לא מופיע. בדקו בעמוד העובדים אם הוא ברשימה "לא פעילים", או ב"שחזור עובדים שנמחקו". בדקו גם שהמספר או תעודת הזהות זהים (תעודת זהות עם 0 בסוף או בלעדיו נחשבת עובד אחר).

❓ עובדים לא פעילים מופיעים ברשימה

זה כך בכוונה. סננו לפי Status (1 פעיל).

❓ מה המשמעות של Status 3?

עובד בטיוטה (עדיין לא הושלם הקמתו).

❓ אפשר לקבל רק מחלקה אחת?

לא, הקריאה מחזירה את כל החברה. סננו לפי DeptName או DeptCode אצלכם.

❓ אפשר לשלוח את הפרמטרים ב-POST?

כן, GET ו-POST נתמכים, ומומלץ POST כדי שהסיסמה לא תופיע בכתובת.

❓ התפקיד של העובד חסר ב-role

מוצגים רק תפקידים פעילים של החברה. תפקיד שבוטל לא יופיע.

❓ ראיתי בעבר "Invalid username or password"

זו לא ההודעה שהמערכת מחזירה כיום. ההודעות הן אלו שבטבלה למעלה.

❓ אפשר לקבל גם תעודת זהות?

השדה לא חוזר בקריאה זו. השדה EmpNo הוא מספר העובד.

❓ אני רוצה להוסיף עובד דרך ה-API

ראו "API להוספת עובד חדש".

מילון מונחים

API – ממשק לקריאה אוטומטית של נתונים מהמערכת.
msg – גוף התשובה: עובדים או קוד שגיאה.
Status – סטטוס העובד: 1 פעיל, 2 לא פעיל, 3 טיוטה.
EmpNo – מספר העובד.

סיכום מהיר

מה רוצים לעשות	איפה	מה זה משנה
למשוך את כל העובדים	GET או POST ל-`/api/getEmp` עם `u`, `p`	מתקבלת רשימה של כל עובדי החברה
לסנן פעילים	השדה `Status`	1 = פעיל
להפעיל את השירות	פנייה לתמיכה	מונע `no_have_permission`

api לקבלת רשימת עובדים