עבודה עם ה-REST API של Timix.AI — מפתחות, כותרת אימות, נקודות קצה

ל-Timix.AI יש REST API מבוסס-מפתח לבניית אינטגרציות משלכם — למשוך נתונים ללוחות בקרה פנימיים, לדחוף רישומי זמן מכלי אחר, או להפוך דיווחים לאוטומטיים. זוהי יכולת Professional+; הנה איך להשיג מפתח ולבצע את הקריאה הראשונה.

1. יצירת מפתח API

פתחו את Organization → API Keys ובחרו Generate a new key: תנו לו שם (למשל CI pipeline או Zapier) ואופציונלית תאריך תפוגה. המפתח המלא מוצג פעם אחת בלבד — Timix.AI שומרת רק hash — לכן העתיקו אותו למקום בטוח מיד. המפתחות מתחילים ב-bbl_.

עמוד ה-API Keys — יצירת מפתח בעל שם (מוצג פעם אחת)

2. ביצוע הקריאה הראשונה

כתובת הבסיס של ה-API היא https://api.timix.ai/api/integration/v1. שלחו את המפתח בכותרת X-Api-Key (או כ-Authorization: Bearer bbl_…). לדוגמה, כדי לקבל את הזהות הקוראת ואת הארגון:

curl https://api.timix.ai/api/integration/v1/me \
  -H "X-Api-Key: bbl_your_key_here"

3. קריאה וכתיבה של הנתונים שלכם

ה-API חושף את סביבת העבודה שלכם לאורך ההיררכיה. משאבים נפוצים:

/customers, /projects, /tasks, /subtasks — המבנה (GET, וגם יצירה/עדכון/מחיקה במקומות המותרים)
/org-users, /organization, /me — אנשים וסביבת העבודה
/invoices, /holiday-profiles — חיוב ולוחות שנה
/financial-reports/... — revenue, budget-health, unbilled-time, customer-billing (לכמה מהם גרסת /export/csv)

אותם כללים שחלים באפליקציה חלים דרך ה-API: רישום זמן שייך ל-SubTask הנכון, לקוחות יושבים תחת הארגון שלכם, ופרויקטים מצטברים כראוי. אם אתם מעדיפים שידחפו אליכם שינויים במקום לתשאל עליהם, שלבו את ה-API עם Webhooks.

4. שמירה על אבטחת המפתחות

התייחסו לכל מפתח כאל סיסמה. הגבילו אותו לאינטגרציה אחת, קבעו תפוגה היכן שאפשר, ומחקו אותו ברגע שהוא כבר לא נחוץ או עשוי להיחשף — הביטול בעמוד ה-API Keys נכנס לתוקף מיידית. כשרק רוצים אינטגרציה נפוצה בלי לכתוב קוד, המחברים ללא קוד מגיעים לשם מהר יותר.

שאלות שכדאי לדעת

מהי כתובת הבסיס ואיך מאמתים?

ה-REST API נמצא ב-https://api.timix.ai/api/integration/v1. אמתו כל בקשה עם המפתח בכותרת X-Api-Key (X-Api-Key: bbl_…) — או, באופן שקול, כ-bearer token (Authorization: Bearer bbl_…). המפתחות מתוחמים לארגון שבו נוצרו.

אילו נקודות קצה זמינות?

קריאה וכתיבה של משאבים לאורך ההיררכיה — /me, /organization, /customers, /projects, /tasks, /subtasks, /org-users, /invoices, /holiday-profiles — וגם דוחות פיננסיים תחת /financial-reports (revenue, budget-health, unbilled-time, customer-billing), לכמה מהם גם ייצוא CSV. אותם כללי היררכיה חלים: רישומים שייכים ל-SubTask הנכון, בדיוק כמו באפליקציה.

איך מסובבים או מבטלים מפתח?

בעמוד ה-API Keys לכל מפתח יש פעולת מחיקה; הביטול מיידי, כך שכל אינטגרציה שמשתמשת בו מפסיקה לעבוד מיד. המפתח המלא מוצג רק פעם אחת ביצירה (אנו שומרים hash), לכן התייחסו אליו כאל סיסמה וצרו חדש אם הוא נחשף.

עבודה עם ה-API