ה API הבא מאפשר דיווח שעות ו/או הוצאות.
הפניה צריכה להיות (תמיד) מוצפנת דרך https וניתן לפנות ב POST או ב GET.
הכתובת אליה צריך להפנות את קריאות הAPI היא:
https://api.icount.co.il/api/v1.php
התגובה תתקבל בפורמט json בלבד.
שם השדה | סוג | תיאור | ערכים אפשריים | ברירת מחדל | חובה |
---|---|---|---|---|---|
פרמטרים | |||||
compID | varchar | מזהה החברה שלך | כן | ||
user | varchar | שם משתמש | כן | ||
pass | varchar | סיסמה | כן | ||
action | varchar | סוג הפעולה. במקרה הזה זה תמיד report_hours_and_expenses | כן | ||
date | varchar | תאריך הערך | YYYY-mm-dd | כן | |
num_of_hours | float | מספר השעות | 5,1.5,1.75 | לא | |
total_expenses | varchar | סכום ההוצאות (אם יש הוצאה, אחרת אפשר להשאיר ריק) | לא | ||
expenses_currency | varchar | מטבע ההוצאה (אם יש הוצאה ואם המטבע אינו ש"ח) | 5 | לא | |
client_id | int | מספר לקוח במערכת iCount | לא | ||
client_name | varchar | שם החברה (שם הלקוח) | לא | ||
assigned_user_id | int | מספר המשתמש המדווח (אם לא יודעים מה מספר המשתמש המערכת תזהה לבד לפי שם המשתמש) | לא | ||
assigned_user_name | varchar | שם המשתמש המדווח (חובה אם אין מספר משתמש) | לא | ||
project_id | int | מספר פרויקט (אם לא יודעים מה מספר הפרויקט המערכת תזהה לבד לפי שם הפרויקט) | לא | ||
project_name | varchar | שם הפרויקט | לא | ||
hour_type_id | int | סוג השעה לחיוב (אם לא יודעים מה מספר סוג השעה המערכת תזהה לבד לפי שם סוג שעה) | לא | ||
hour_type_name | varchar | שם סוג השעה לחיוב | לא | ||
h_desc | varchar | תיאור העבודה | לא | ||
e_desc | varchar | תיאור ההוצאה | לא |
התשובה החוזרת תיראה ככה:
( 'status' => 'ok', 'reason' => 'some text' )