API בקצרה

בסיס

• Base URL: https://erp.tamit.co.il/v1/
• אימות: Header Authorization: Bearer <TOKEN>
• Content-Type: JSON (ברירת מחדל)
• Idempotency: כל POST תומך ב-Idempotency-Key

"Hello, API"

הקריאה הפשוטה ביותר — אימות שהטוקן שלך עובד:

אמורה לחזור: {"id":..., "email":...}. אם 401 — הטוקן לא תקין.

קטגוריות endpoints

165 endpoints מחולקים ל-9 קטגוריות. הנה תמצית של הקטגוריות העיקריות:

• Documents — /v1/documents · יצירת טיוטה, סגירה, המרה, משיכה, חיפוש
• Accounts — /v1/accounts · לקוחות וספקים, חיפוש, יתרה, היסטוריה
• Items — /v1/items · מלאי, לוט, סיריאל, ספקים פר-פריט
• Payments — /v1/payments · סליקה Z-Credit, טוקנים, חיוב, זיכוי
• Dunning — /v1/dunning · גיול חוב, תזכורות, preview
• Reports — /v1/financial-reports · רווח, מאזן, מע"מ, מכירות
• Uniform Export — /v1/uniform-export · BKMV bundle, summary
• Users — /v1/users · ניהול משתמשים, תפקידים
• Webhooks — /v1/webhooks · רישום והאזנה לאירועים

הספריה המלאה — Scalar reference ב-erp.tamit.co.il/docs.

Webhooks — בקצרה

במקום לעשות polling — אפשר להירשם לאירועים. רישום ב-POST /v1/webhooks עם URL ורשימת אירועים. כל אירוע נשלח כ-POST עם payload JSON + header X-Tamit-Signature (HMAC SHA-256 על הגוף).

אירועים פופולריים: document.created, document.promoted, payment.received, payment.failed.

המערכת מנסה לשלוח כל אירוע 5 פעמים עם backoff אקספוננציאלי (1s, 10s, 100s, 1000s, 10000s). אם אחרי 5 ניסיונות עדיין נכשל — נשמר ב-dead-letter queue וזמין דרך GET /v1/webhooks/failed לטיפול ידני.

SDKs (בקרוב)

בכל שפה גדולה (Node.js, Python, Ruby, PHP, .NET) — SDK שעוטף את ה-API. בינתיים העבודה ישירות עם fetch/requests/curl פשוטה למדי.

הקוד הציבורי של ה-SDKs נמצא ב-GitHub כשהם משתחררים. עד אז — Scalar reference מציע "Generate code" בכל endpoint שיוצר snippet בכל שפה לבחירתך.

Zapier, Make, n8n

אינטגרציה פשוטה דרך פלטפורמות no-code: השתמש ב-"HTTP Request" וצרף את ה-Bearer token. אנחנו עובדים על אפליקציה רשמית לכל פלטפורמה — מצפים להשקה ברבעון הקרוב.

בינתיים, התבנית הפשוטה: trigger ב-Zapier (למשל "New row in Sheet") → "Create Document" ב-Tamit (POST /v1/documents/drafts) → "Promote" (POST /v1/documents/drafts/{id}/promote).

גרסאות API

הגרסה הנוכחית: /v1/. כל שינוי שעלול לשבור (breaking change) — יקבל גרסה חדשה (/v2/). הגרסה הקודמת תישאר זמינה 12 חודשים מינימום, עם הודעות הפסקה מראש.

שינויים שאינם שוברים (הוספת שדה, endpoint חדש, פיצ'ר אופציונלי) — נכנסים ל-/v1/ ישירות, ללא versioning.

סטטוס המערכת

סטטוס בזמן-אמת: status.tamit.co.il. הרשמה להודעות התרעה במייל/SMS — מומלצת לאינטגרציות קריטיות.

קבלת מפתח API

1. 1. היכנס ל-erp.tamit.co.il
2. 2. הגדרות → מפתחות API
3. 3. "צור מפתח חדש" → תן שם (למשל "Zapier integration")
4. 4. העתק את המפתח עכשיו — מוצג פעם אחת בלבד.

שגיאות נפוצות

• שגיאה: 401 unauthorized
  פתרון: הטוקן חסר או שגוי. וודא שיש header Authorization: Bearer ... ושהטוקן עדיין פעיל.
• שגיאה: 429 rate limit
  פתרון: חרגת מהמכסה — חכה לפי Retry-After. או שדרג מסלול.
• שגיאה: 422 validation_failed
  פתרון: שדה חסר או שגוי. בדוק את ה-details בתגובה.

קשור

• API מלא + 10 דוגמאות
• Scalar reference
• אבטחה