# מבוא

ה-API של banta מאפשר לחבר את מערכת ניהול המשכנתאות למערכות אחרות: אתרי שיווק ודפי נחיתה, מערכות CRM, אוטומציות (Make, Zapier, n8n), BI וכלים פנימיים. כל קריאה פועלת על נתוני הארגון שאליו משויך מפתח ה-API, ורק עליהם.

## מה אפשר לעשות

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

## כתובת הבסיס

כל נקודות הקצה נמצאות תחת:

```
https://app.banta.co.il/api-service
```

לדוגמה, רשימת הלידים: `GET https://app.banta.co.il/api-service/leads`.

## פורמט הנתונים

- **JSON בלבד** - בקשות עם גוף נשלחות עם `Content-Type: application/json`, והתגובות תמיד JSON בקידוד UTF-8.
- **מזהים** - כל המזהים הם UUID.
- **תאריכים** - בפורמט ISO 8601. שדות תאריך-ושעה (`created_at`, `updated_at`) כוללים אזור זמן; שדות תאריך בלבד נשלחים כ-`YYYY-MM-DD`.
- **סכומים** - מספרים (לא מחרוזות), בשקלים, אלא אם צוין אחרת בשדה.
- **תשובות שגיאה** - מבנה אחיד, ראו [שגיאות](https://docs.banta.co.il/he/guides/errors.md).

## גרסאות ותאימות

הגרסה הנוכחית של ה-API היא 1.1.0. כתובות ה-API אינן כוללות מספר גרסה. שינויים שמוסיפים שדות או נקודות קצה יכולים להיכנס בכל עת, ולכן כדאי לכתוב קוד שמתעלם משדות שאינו מכיר. שינויים שוברים יפורסמו מראש בעמוד [עדכונים](https://docs.banta.co.il/he/guides/changelog.md). תיקוני אבטחה הם החריג: הם עשויים להיכנס מיד.

## גרסה לסוכני AI

כל התיעוד זמין גם כטקסט נקי לסוכני AI ולמודלי שפה: [`llms.txt`](https://docs.banta.co.il/he/llms.txt), [`llms-full.txt`](https://docs.banta.co.il/he/llms-full.txt) וקובץ Markdown לכל נקודת קצה. אפשר גם לחבר את banta ישירות ל-Claude או ל-ChatGPT דרך MCP. ראו [סוכני AI ו-MCP](https://docs.banta.co.il/he/guides/ai-agents.md).

## מה עוד לא קיים

- **Webhooks** - ה-API לא שולח אירועים. במקום זה שלפו רשומות חדשות באופן תקופתי; ב[מגבלות קצב](https://docs.banta.co.il/he/guides/rate-limits.md) מתואר דפוס סנכרון יעיל.
- **מפתחות idempotency** - קראו את [שגיאות](https://docs.banta.co.il/he/guides/errors.md) לפני שליחה חוזרת של `POST` אחרי timeout.
- **סביבת ניסוי (sandbox)** - כל מפתח עובד על נתונים אמיתיים. ראו "בדיקות בלי סיכון" ב[התחלה מהירה](https://docs.banta.co.il/he/guides/quickstart.md).

## תמיכה

שאלות על ה-API: [support@banta.co.il](mailto:support@banta.co.il). מדריכים על המערכת עצמה נמצאים ב[מרכז העזרה](https://help.banta.co.il). התיעוד הזה זמין גם [באנגלית](https://docs.banta.co.il/).

---

חלק מתיעוד ה-API של banta. אינדקס מלא: https://docs.banta.co.il/he/llms.txt