ממשק זה מאפשר לקבל מידע מפורט על כל העובדים שעבדו ביום מסוים, כולל פרטי עובד, נתוני משמרת, פירוט שכר וחלוקת שעות (100%, 125%, 150% וכו').
פרטי ה-Endpoint
Method:
GETURL:
https://api.restigo.co.il/api/thirdParty/get_employees_hoursAuthorization: נדרש Header מסוג
RESTIGO-API-KEY
פרמטרים נדרשים (Query Params)
branch_id: מזהה הסניף (מספר).working_date: התאריך המבוקש בפורמטyyyy-mm-dd.
מבנה השדות בתשובה (Response Fields)
| שם השדה | סוג נתון | תיאור |
branch_id | Number | מזהה סניף |
firstNameString
שם פרטי
lastNameString
שם משפחה
IdentifierString
תעודת זהות
mobile_numberString
מספר טלפון נייד
Start_dateString
תאריך ושעת התחלה
End_dateString
תאריך ושעת סיום
hours_totalNumber
סך כל שעות העבודה
BreakNumber
זמן הפסקה (במידה והוגדר)
daily_notesString
הערות למשמרת
hours_100Number
כמות שעות 100%
hours_125Number
כמות שעות 125%
hours_150Number
כמות שעות 150%
hours_175Number
כמות שעות 175%
hours_200Number
כמות שעות 200%
hours_150_shabatNumber
שעות 150% ביום שבת
bank_nameString
שם הבנק
bank_branch_numberString
מספר סניף בנק
account_numberString
מספר חשבון בנק
דוגמת קריאה (Request Example)
Request:
JavaScript
https://api.restigo.co.il/api/thirdParty/get_employees_hours?branch_id=1
234&working_date=2024-12-08
fetch(url, {
method: 'GET',
headers: {
'RESTIGO-API-KEY': 'YOUR_API_KEY_HERE'
}
})
.then(response => response.json())
.then(data => console.log(data));
דוגמת תשובה (Response Example)
{
"data": [
{
"branch_id": 1,
"firstName": "גבי",
"lastName": "קניקובסקי",
"identifier": null,
"start_date": "2024-12-08 05:00:00",
"end_date": "2024-12-08 22:00:00",
"shift_title": "מלצר פתיחה",
"daily_notes": null,
"break": 0,
"hours_total": 17,
"hours_100": 8,
"hours_125": 2,
"hours_150": 7,
"hours_175": 0,
"hours_200": 0,
"hours_150_shabat": 0,
"mobile_number": "0524522890",}
"bank_name": "בנק לאומי לישראל בע\"מ",
"bank_branch_number": "998",
"account_number": "18761616"
}
]
Endpoint
Method: POST
Url for production: https://api.restigo.co.il/api/customer/branches/{branch_id}/users
Url for development: https://dev.restigo.co.il/api/customer/branches/{branch_id}/users
Request
Headers
key | value |
RESTIGO-API-KEY | Provided separately |
המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית.
Path Parameters
Parameter | Type | Required | Description | |
branch_id | integer | ✅ | The ID of the branch where the user will be created |
Body Parameters (JSON)
Parameter | Type | Required | Description | |
users | array | ✅ | A list of users to be created | |
first_name | string | ✅ | User's first name | שם פרטי |
last_name | string | ✅ | User's last name | שם משפחה |
email_address | string | ✅ | A valid email address for the user | דואר אלקטרוני |
mobile_phone | string | ❌ | User's mobile phone number (nullable) | טלפון סלולרי |
privileges_id | integer | ❌ | The user's privilege group (nullable) | הרשאות |
job_type | integer | ❌ | The ID representing the user's job type (nullable) | מחלקה |
salary | float | ❌ | User's salary (nullable) | שכר בסיס |
travel_cost | float | ❌ | User's travel cost reimbursement (nullable) | ערך נסיעות |
Example Request:
{
"users": [
{
"first_name": "john",
"last_name": "doe",
"email_address": "[email protected]",
"mobile_phone": null,
"privileges_id": null,
"job_type": null,
"salary": null,
"travel_cost": null
},
{
"first_name": "mike",
"last_name": "mike",
"email_address": "[email protected]",
"mobile_phone": null,
"privileges_id": null,
"job_type": null,
"salary": null,
"travel_cost": null
}
]
}
Response
Success Response
Status Code: 201 Created
Example Response
{
"message": "Users created successfully",
"user": [
{
"id": 255095,
"first_name": "john",
"last_name": "doe",
"email_address": "[email protected]"
},
{
"id": 255096,
"first_name": "mike",
"last_name": "mike",
"email_address": "[email protected]"
}
]
}
ביצירת עובד נשלח מייל לכתובת המייל שהוזנה לעובד עם סיסמא להתחברות לרסטיגו (שם המשתמש לכניסה למערכת הוא כתובת המייל).
Error Response
Validation Error
Status Code: 422 Unprocessable Entity
Example Response:
{
"errors": {
"users.0.email_address": [
"validation.required"
],
"users.1.email_address": [
"validation.unique"
]
}
}
במידה ומתקבלת השגיאה הבאה:
validation.unique
יש לנסות כתובת מייל שונה, או לפנות לרסטיגו בטלפון 074-7050790 על מנת שנבדוק את הכתובת הרלוונטית מאחר והיא כבר משוייכת למשתמש אחר ברסטיגו.
Unauthorized Request
Status Code: 401 Unauthorized
Example Response:
{
"message": "Unauthorized"
}
Branch Not Found
Status Code: 404 Not Found
Example Response:
{
"errors": "Invalid branch_id for the provided customer"
}
Endpoint
Method: PATCH
Url for production: https://api.restigo.co.il/api/customer/branches/{branch_id}/users/{user_id}/reset-password
Url for development: https://dev.restigo.co.il/api/customer/branches/{branch_id}/users/{user_id}/reset-password
Request
{
"method": "PATCH",
"url": "https://api.restigo.co.il/api/customer/branches/{branch_id}/users/{user_id}/reset-password",
"headers": {
"RESTIGO-API-KEY": "Provided separately"
},
"path_parameters": {
"branch_id": {
"type": "integer",
"required": true,
"description": "The ID of the branch"
},
"user_id": {
"type": "integer",
"required": true,
"description": "The ID of the user"
}
},
"body": {},
"notes": [
"המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית."
]
}
Response
Success Response
Status Code: 200 Ok
Example Response
{
"message": "Password reset successfully, please check your mobile number: 0540000000 for instructions."
}
{
"message": "Password reset successfully, please check your email [email protected] for instructions."
}
באיפוס סיסמה אם הוגדר למשתמש גם כתובת מייל וגם טלפון סלולרי- איפוס הסיסמא יישלח לטלפון. אם הוגדר רק מייל נשלח לכתובת מייל שהוגדר.
ממשק עובדים time Real :
https://app.restigo.co.il/api/pos/{provider}/receive/employees
יש להקים ממשק time Real אשר יישלח נתונים בכל 3 דקות ויכיל את הנתונים הבאים:
• מס' עובד
• שם העובד
• תאריך כניסה
• שעת כניסה
• תאריך יציאה
• שעת יציאה
ז.ת •
• כתובת מייל
{
"restigo": {
הממשק יכיל את שעות העובדים שנכנסו ו / או יצאו שעתיים אחורה
:
"branch_id": int, "key": string,
"employees": [
{
"number": int,
"start_date": string,// yyyy-mm-dd "end_date": string,// yyyy-mm-dd "start_time": string,// hh:ii "end_time": string,// hh:ii "identifier": string, (optional) "eMail": string (optional)
}
]
}
}
בעזרת ממשק זה ניתן לקבל רשימת עובדים בסניף.
Endpoint
Method: GET
Url for production: https://api.restigo.co.il/api/customer/branches/{branch_id}/users
Url for development: https://dev.restigo.co.il/api/customer/branches/{branch_id}/users
Request
Headers
key | value |
RESTIGO-API-KEY | Provided separately |
המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית.
Response
Success Response
Status Code: 200 Ok
Example Response
[
{
"id": 101701,
"first_name": "משה",
"last_name": "בייקרי אנד מור",
"email_address": "[email protected]",
"mobile_number": "054-2232701"
},
{
"id": 101702,
"first_name": "משה",
"last_name": "בייקרי אנד מור",
"email_address": "[email protected]",
"mobile_number": "054-2232701"
},
{
"id": 255099,
"first_name": "john",
"last_name": "doe",
"email_address": "[email protected]",
"mobile_number": "0540000000"
},
{
"id": 255100,
"first_name": "mike",
"last_name": "mike",
"email_address": "[email protected]",
"mobile_number": null
}
]
Error Response
Unauthorized Request
Status Code: 401 Unauthorized
Example Response:
{
"message": "Unauthorized"
}
Branch not found
Status Code: 404 Not Found
Example Response:
{
"errors": "Invalid branch_id for the provided customer"
}