תיעוד API

חיבור ועבודה עם ממשק ה-API של Shifton

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


תיעוד API

אנו תומכים בשתי גרסאות של התיעוד שלנו:


להתחיל בעבודה

השגת מפתח API

במהלך הגדרות החברה שלכם בפלטפורמת Shifton, צרו מפתח API.
האישור נעשה דרך הכותרת:

Authorization: Bearer {your_api_key}

בצעו את הבקשה הראשונה שלכם

לדוגמה, כדי להחזיר רשימת עובדים:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

תגובה לדוגמה:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

שילוב ה-API במהלכים שלכם

  • יצירה ושינוי אוטומטי של משמרות

  • ניהול בקשות חופשה ומחלה

  • ייצוא נתונים למערכות שכר

  • בנו לוחות מחוונים ודוחות מותאמים אישית


יכולות API בסיסיות

  • עובדים – הוספה, עריכה וניהול תפקידים

  • לוחות זמנים – יצירה, התאמת משמרות, תכנון עבודה

  • חופשות והיעדרויות – ניהול בקשות חופשה ומחלה

  • דיווחים – ייצוא נתוני זמן, שכר ונוכחות


קודי שגיאה

ה-API של Shifton משתמש בקודי מצב סטנדרטיים של HTTP:

  • 200 — בקשה מוצלחת

  • 201 — אובייקט נוצר בהצלחה

  • 400 — פרמטרים לא תקינים

  • 401 — שגיאה בהרשאה (מפתח API לא תקין)

  • 403 — גישה נדחתה

  • 404 — משאב לא נמצא

  • 500 — שגיאת שרת


טיפים לשימוש

  • תמיד השתמשו ב-גרסת API החדשה עבור אינטגרציות חדשות

  • השתמש בPostman או curl לבדיקות

  • כבד את מגבלות הקצבים כדי להימנע מחסימות

  • עדכן אינטגרציות שעדיין נסמכות על התיעוד הישן


שתף את הפוסט הזה