תיעוד API

קבלת קוד אימות

שולחים בקשת POST עם מספר הטלפון של הלקוח, ומקבלים בחזרה את הקוד שהנציג מקריא ללקוח כדי להוכיח שהוא נציג אמיתי. אם ללקוח כבר יש קוד פעיל (הוא כבר פתח את האפליקציה, או שנציג אחר כבר שלף אותו) — תתקבל אותו קוד בדיוק; אחרת ייווצר קוד חדש. כל קוד תקף 3 דקות מרגע ההפקה, וכל זוג לקוח+חברה יכול להחזיק קוד חי אחד בלבד באותו רגע.

בקשה לדוגמה:

curl -X POST https://api.voisure.com/api/v1/verify \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"customer_phone": "0521234567"}'

תשובה מוצלחת (200):

{ "code": "384920", "expiresAt": "2026-08-24T12:03:00.000Z" }

תגובת שגיאה לדוגמה:

{ "error": "Company is not approved" }

קודי שגיאה:

הגבלת קצב ושגיאות

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

לנסות בעצמכם

עם מפתח API תקף של חברה מאושרת, אפשר לבדוק את הקריאה ישירות מהטרמינל:

# 1. verify a customer's code (creates one if none is active yet)
curl -i -X POST https://api.voisure.com/api/v1/verify \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"customer_phone": "0521234567"}'

# 2. call it again immediately - within 3 minutes you'll get back
#    the exact same code, not a new one
curl -i -X POST https://api.voisure.com/api/v1/verify \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"customer_phone": "0521234567"}'

אין כרגע סביבת sandbox נפרדת - הבדיקות רצות מול אותה מערכת production, עם קוד אימות אמיתי שתקף 3 דקות.