מענה על טופס באמצעות ממשק API

המערכת מאפשרת לענות על טפסים באמצעות בקשת POST, שימושי למערכות חיצוניות ולסנסורים השולחים דיווחים ל־Vitre.

דרישות מוקדמות

• API Key פעיל

• הגדרת Data Key לכל שאלה בטופס

• גישה ל־Swagger: https://publicapi.hbinov.com/swagger/index.html

שלב 1: הגדרת Data Key לכל שאלה

1. היכנסו לטופס הרלוונטי.

2. לחצו על אייקון העיפרון ליד כל שאלה.
   

3. הזינו Data Key ברור ועקבי, לדוגמה: temperature_c, issue_type, location.

4. שמרו.

הערה: Data Key הוא המפתח שבעזרתו ה־API ממפה ערכים לשאלות.

שלב 2: התחברות ב־Swagger ובחירת נקודת קצה

1. פתחו את https://publicapi.hbinov.com/swagger/index.html.

2. לחצו על Authorize, הזינו את ה־API Key כ־Bearer.
   

3. מצאו את נקודת הקצה לשליחת מענה לטופס, לדוגמה:
   POST /api/forms/{formId}/review/submit או POST /api/forms/{formId}/submit
   השתמשו בשם הנתיב המדויק שמופיע אצלכם ב־Swagger.

שימו לב - בקשה זו תומכת ב-STRING, DICTIONARY ויישויות ממערכת Vitre.
עבור DICTIONARY או יישות יש לשלוח בבקשה את הEXTERNAL ID.
לדוגמה - אם ארצה לדווח על מיקום ספציפי, אשלח את ה-EXTERNALID הקיים במערכת.