דילוג לתוכן

API ו-Webhooks

כל מה שיש בממשק, יש ב-API.

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

יסודות

מה צריך לדעת לפני הקריאה הראשונה.

כתובת בסיס
/api/v1
אימות
Authorization: Bearer vp_sk_…
מפתח בדיקות
vp_sk_test_…
סכומים
מספר שלם של אגורות. 23600 הוא 236.00 ₪
תאריכים
YYYY-MM-DD לפי שעון ישראל
גרסה
Viper-Api-Version: 2026-11-01
מזהה בקשה
X-Request-Id

בנוי לפרודקשן

דברים שלא תצטרכו לבנות בעצמכם.

  • Idempotency-Key

    בקשה שנשלחה פעמיים מחזירה את אותה תשובה. ויש שכבה שנייה בתוך רשומת המסמך, החיוב וההחזר.
  • בדיקות שלא יכולות לטעות

    מפתח בדיקות מגיע רק לעסק בדיקות. טריגר במסד הנתונים מונע מעסק בדיקות להפוך לחי. מסמך בדיקה מסומן ככזה בכל עמוד.
  • Webhooks חתומים

    האירוע נכתב באותה טרנזקציה של השינוי, נחתם, ונשלח שוב עד שמתקבל. לכל אירוע סכמה ב-OpenAPI.
  • הרשאות למפתח

    scopes לכל משאב, תוקף למפתח, ורק ה-hash נשמר. יצירה וביטול נרשמים ביומן העסק.
  • שגיאות שאפשר לטפל בהן

    type, code ו-message קבועים, עם message_he בעברית שאפשר להציג למשתמש כמו שהוא.
  • דפדוף ומגבלות קצב

    דפדוף בשרת בכל רשימה. עד 600 בקשות בדקה למפתח, וכותרות X-RateLimit בכל תשובה.

אירועים

אתם יודעים על כל שינוי, בלי לשאול.

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

  • document.issued
  • document.signed
  • document.paid
  • document.allocation_updated
  • payment.succeeded
  • payment.refunded
  • subscription.charge_succeeded
  • subscription.charge_failed
  • checkout.completed
  • report.ready
  • +30

מפתח בדיקות,
עוד היום.

פותחים חשבון, יוצרים עסק בדיקות ומפתח vp_sk_test_, ומפיקים חשבוניות, חיובים ו-Webhooks בלי כסף אמיתי ובלי מסמכים חוקיים.