> For the complete documentation index, see [llms.txt](https://invoice4u.gitbook.io/invoice4u-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://invoice4u.gitbook.io/invoice4u-docs/he/getting-started/welcome.md).

# ברוכים הבאים

‫ה-API של Invoice4U מאפשר לכם ליצור מסמכים תקינים מבחינת מס (חשבוניות, קבלות, חשבוניות זיכוי ועוד), לנהל לקוחות וסניפים, ולחייב כרטיסי אשראי דרך שירות הסליקה של Invoice4U — הכל מתוך האפליקציה שלכם.‬

‫השתמשו בו לאוטומציה של תהליכי חיוב, סנכרון ה-CRM או חנות האינטרנט שלכם עם Invoice4U, וגביית תשלומים באמצעות דפי סליקה מתארחים, טוקנים של כרטיסים שמורים או הוראות קבע.‬

### ‫קבלת גישה‬

1. ‫צרו חשבון ב-[invoice4u.co.il](https://invoice4u.co.il).‬
2. ‫הפעילו גישת API לארגון שלכם (הגדרות ← API, או פנו לתמיכה).‬
3. ‫בצעו אימות עם מפתח ה-API שלכם והשתמשו בו בקריאות ל-API.‬

### ‫כתובות בסיס‬

| ‫סביבה‬       | ‫כתובת בסיס‬                                            |
| ------------- | ------------------------------------------------------- |
| ‫פרודקשן‬     | `https://api.invoice4u.co.il/Services/ApiService.svc`   |
| ‫QA (בדיקות)‬ | `https://apiqa.invoice4u.co.il/Services/ApiService.svc` |

‫כל המתודות בתיעוד הזה יחסיות לכתובות הבסיס האלה. פתחו ובדקו מול **QA** תחילה, ואז החליפו את כתובת הבסיס ל**פרודקשן**.‬

{% hint style="info" %}
‫ה-API הוא שירות WCF החשוף כ-REST (JSON). קיים גם endpoint של SOAP בכתובת `{baseUrl}/Soap` (basicHttpBinding) לאינטגרציות ישנות, אך REST/JSON הוא הממשק המומלץ והמתועד.‬
{% endhint %}

### ‫פורמט הבקשות‬

‫אלא אם צוין אחרת, הקריאות למתודות מתבצעות ב-**POST** עם גוף JSON שעוטף את פרמטרי הפעולה לפי שם (סגנון "wrapped request" של WCF):‬

```http
POST /Services/ApiService.svc/CreateDocument HTTP/1.1
Host: api.invoice4u.co.il
Content-Type: application/json

{
  "doc": { ... },
  "token": "<your-token>"
}
```

### ‫אימות‬

‫כמעט כל מתודה מקבלת פרמטר `token` — זהו **מפתח ה-API** של הארגון שלכם (GUID), המועבר בגוף של כל קריאה. ראו [סקירת אימות](/invoice4u-docs/he/authentication/overview.md).‬

### ‫מעטפת התשובה‬ <a href="#response-envelope" id="response-envelope"></a>

‫רוב אובייקטי התשובה יורשים מעטפת משותפת. תמיד בדקו את `Errors` לפני שימוש בתוצאה:‬

| ‫שדה‬      | ‫סוג‬  | ‫תיאור‬                                                                                                                          |
| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `Errors`   | array  | ‫רשימת שגיאות. ריקה בהצלחה. כל פריט: `ID` (קוד שגיאה מספרי), `Error` (שם השגיאה), `Paramters` (הקשר אופציונלי, למשל מספר שורה).‬ |
| `Info`     | array  | ‫הודעות מידע (למשל `SuccessfulAction`).‬                                                                                         |
| `OpenInfo` | object | ‫תוספות מפתח/ערך שחלק מהמתודות מחזירות (למשל `PaymentMismatchDelta`).‬                                                           |

### ‫צעדים ראשונים‬

‫עברו על [ההתחלה המהירה](/invoice4u-docs/he/getting-started/quick-start.md) ואז קראו את [הטיפים והחידודים](/invoice4u-docs/he/getting-started/key-tips.md).‬

### ‫משאבים קריאים למכונה‬

* ‫[מפרט OpenAPI 3.0 בפורמט JSON](https://raw.githubusercontent.com/invoice4udev-hue/i4u-docs/main/openapi/invoice4u-openapi.json) — כל ממשק ה-API עבור מחוללי קוד, Postman וסוכני AI.‬
* ‫[אוסף Postman](https://raw.githubusercontent.com/invoice4udev-hue/i4u-docs/main/openapi/Invoice4u%20API%20collection.postman_collection.json) — בקשות מוכנות לכל מתודה מתועדת.‬
* ‫סוכני AI: האתר מגיש [llms.txt](https://invoice4u.gitbook.io/invoice4u-docs/llms.txt), וכל עמוד זמין כ-Markdown על ידי הוספת `.md` לכתובת שלו.‬

### ‫תמיכה‬

‫לעזרה באינטגרציה, פנו לתמיכת Invoice4U דרך החשבון שלכם. צרפו לכל פנייה את המתודה (endpoint) שנקראה, גוף הבקשה, גוף התשובה והסביבה (QA/פרודקשן).‬

### ‫עמודים הבאים‬

* ‫[התחלה מהירה](/invoice4u-docs/he/getting-started/quick-start.md)‬
* ‫[סקירת אימות](/invoice4u-docs/he/authentication/overview.md)‬
* ‫[סקירת מתודות מסמכים](/invoice4u-docs/he/documents/overview.md)‬