API למפתחים

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

JSONHTTPS בלבדUTF-88 נתיבים מתועדים

לפני שמתחילים

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

Shortcuts APIapi_token=YOUR_SHORTCUT_TOKEN

Shortcuts API

8 endpoints
POST/app/api/add_shift.php

מוסיף משמרת חדשה לסידור העבודה של המשתמש, כולל עבודה, שעות וסוג משמרת אופציונלי.

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/delete_shift.php

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

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/get_categories.php

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

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/get_shifts.php

מחזיר את העבודות והמשמרות של המשתמש בחודש מבוקש.

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/save_transaction.php

מוסיף הוצאה או הכנסה חדשה לתאריך של היום, כולל קטגוריה ואמצעי תשלום.

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/save_transaction_dated.php

מוסיף הוצאה או הכנסה חדשה בתאריך שנשלח, או בתאריך של היום אם לא נשלח תאריך.

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/shopping/add_shopping_item.php

מוסיף פריט וכמות לרשימת הקניות של הבית בחנות שנבחרה.

API נתמךShortcut token in api_token

פרמטרים

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-8
POST/app/api/shopping/get_stores.php

מחזיר את רשימת החנויות של הבית לבחירה לפני הוספת פריט קניות.

API נתמךShortcut token in api_token

פרמטרים

אין פרמטרים מתועדים

דוגמת בקשה

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
לא נמצאו נתיבים שמתאימים לחיפוש.