לפני שמתחילים
הנתיבים בדף הזה מיועדים לאינטגרציות חיצוניות ומאומתים באמצעות טוקן. ממשקי האתר, נתיבי ניהול ונתיבים פנימיים אינם חשופים בתיעוד הציבורי.
api_token=YOUR_SHORTCUT_TOKENShortcuts API
8 endpointsPOST/app/api/add_shift.php
מוסיף משמרת חדשה לסידור העבודה של המשתמש, כולל עבודה, שעות וסוג משמרת אופציונלי.
פרמטרים
dateend_timejob_idnoteshift_type_idstart_timeדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/add_shift.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","date":"value","end_time":"value","job_id":1,"note":"value","shift_type_id":1,"start_time":"value"}'מבנה תשובה
{
"status": "success",
"message": "string",
"shift_id": "string",
"starts_at": "string",
"ends_at": "string"
}פורמט
application/jsonUTF-8POST/app/api/delete_shift.php
מוחק משמרת קיימת של המשתמש מסידור העבודה לפי מזהה המשמרת.
פרמטרים
idדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/delete_shift.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","id":1}'מבנה תשובה
{
"status": "success",
"message": "string",
"id": 1
}פורמט
application/jsonUTF-8POST/app/api/get_categories.php
מחזיר את קטגוריות ההוצאה או ההכנסה הפעילות של הבית לבחירה בקיצור דרך.
פרמטרים
typeדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/get_categories.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","type":"value"}'מבנה תשובה
{
"status": "success",
"message": "string",
"categories": "string"
}פורמט
application/jsonUTF-8POST/app/api/get_shifts.php
מחזיר את העבודות והמשמרות של המשתמש בחודש מבוקש.
פרמטרים
monthyearדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/get_shifts.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","month":1,"year":1}'מבנה תשובה
{
"status": "success",
"message": "string",
"year": "string",
"month": "string",
"jobs": "string",
"shifts": "string"
}פורמט
application/jsonUTF-8POST/app/api/save_transaction.php
מוסיף הוצאה או הכנסה חדשה לתאריך של היום, כולל קטגוריה ואמצעי תשלום.
פרמטרים
amountcategory_idcurrency_codedescriptionpayment_method_idtypeדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/save_transaction.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","amount":"value","category_id":1,"currency_code":"value","description":"value","payment_method_id":1,"type":"value"}'מבנה תשובה
{
"status": "success",
"message": "string"
}פורמט
application/jsonUTF-8POST/app/api/save_transaction_dated.php
מוסיף הוצאה או הכנסה חדשה בתאריך שנשלח, או בתאריך של היום אם לא נשלח תאריך.
פרמטרים
amountcategory_idcurrency_codedescriptionpayment_method_idtransaction_datetypeדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/save_transaction_dated.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","amount":"value","category_id":1,"currency_code":"value","description":"value","payment_method_id":1,"transaction_date":"value","type":"value"}'מבנה תשובה
{
"status": "success",
"message": "string"
}פורמט
application/jsonUTF-8POST/app/api/shopping/add_shopping_item.php
מוסיף פריט וכמות לרשימת הקניות של הבית בחנות שנבחרה.
פרמטרים
category_iditem_namequantityדוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/shopping/add_shopping_item.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN","category_id":1,"item_name":"value","quantity":"value"}'מבנה תשובה
{
"status": "success",
"message": "string",
"new_id": "string"
}פורמט
application/jsonUTF-8POST/app/api/shopping/get_stores.php
מחזיר את רשימת החנויות של הבית לבחירה לפני הוספת פריט קניות.
פרמטרים
דוגמת בקשה
curl -X POST "https://hatazrim.com/app/api/shopping/get_stores.php" \
-H "Content-Type: application/json" \
-d '{"api_token":"YOUR_SHORTCUT_TOKEN"}'מבנה תשובה
{
"status": "success",
"message": "string",
"categories": "string"
}פורמט
application/jsonUTF-8