מרכז העזרה › חיבור ב-API
חיבור מערכת ב-API
יש לכם מערכת סגורה — קופה, ERP או מערכת פנימית — בלי חנות מקוונת סטנדרטית? חברו אותה ל-כרטסת דרך API והפיקו חשבונית מס-קבלה אוטומטית בקריאה אחת. זמין בתוכנית איקומרס.
הפיקו מפתח API
בהגדרות → API לוחצים "צור מפתח" (בדיקה או חי). המפתח מוצג פעם אחת — שמרו אותו במקום מאובטח. אפשר לבטל מפתח בכל עת (מערכות שמשתמשות בו יפסיקו לעבוד).
שלחו בקשה
המערכת שלכם שולחת POST ל-/api/v1/tax-receipts עם המפתח בכותרת Authorization: Bearer, ובגוף — פרטי הלקוח, הפריטים והתשלום. מומלץ להוסיף Idempotency-Key (למשל מספר הזמנה) כדי למנוע כפילויות.
קבלו את החשבונית
כרטסת מפיקה חשבונית מס-קבלה (320), רושמת בספרים, מעדכנת את כרטיס הלקוח, ומחזירה מספר, סכומים וקישור ל-PDF. המע״מ מחושב אוטומטית (18% בישראל, 0% ליצוא).
תיעוד טכני מלא
כתובות, שדות, דוגמאות curl, קודי שגיאה וכללי מע״מ — בעמוד התיעוד למפתחים.
שאלות נפוצות
תוכנית איקומרס — יצירת מפתחות והשימוש מוגבלים לתוכנית זו.
חשבונית מס-קבלה (320) — חשבונית וקבלה יחד, נרשמת בספרים, עם קישור ל-PDF.
ברירת מחדל: ישראל 18%, חו״ל (יצוא) 0%. אפשר לשלוח vat_rate מפורש שגובר.
Idempotency-Key — אותו מזהה עסקה מחזיר את אותה חשבונית, בלי כפילות ב-retry.
חשבונית מעל הסף לעוסק מורשה מחייבת מספר הקצאה שאינו נתמך עדיין ב-API — מתקבלת שגיאה ויש להפיק במערכת. פרטי/מתחת לסף — עובר חלק.