מדריך API: הוספת מיקום
הקדמה
שירות זה מאפשר להוסיף מיקום מותר לדיווח חדש למערכת באמצעות קריאה לנקודת הקצה המתוארת להלן.
URL
שיטת קריאה
POST
פרמטרים נדרשים
פרמטר | תיאור | סוג | דוגמה |
| שם המיקום | מחרוזת |
|
| רדיוס המיקום המותר | מספר (נקודה צפה) |
|
| קו רוחב של המיקום | מספר (נקודה צפה) |
|
| קו אורך של המיקום | מספר (נקודה צפה) |
|
| מזהה הלקוח | מספר |
|
תגובה
התשובה משרת ה-API תהיה בפורמט JSON וכוללת את המידע הבא:
פרמטר | תיאור | סוג |
| מצב ההצלחה של הפעולה | בוליאני ( |
דוגמה לבקשת POST
http
POST /index.php/api/add_location HTTP/1.1 Host: 412.co.il Content-Type: application/json { "name": "mylocation1", "radius": 0.5, "lat": 30.0001, "lng": 30.003, "client": 112 }
דוגמה לתשובה
במקרה של הצלחה:
json
{ "status": true }
במקרה של כישלון:
json
{ "status": false }
הערות נוספות
יש לוודא שכל הפרמטרים הנדרשים נשלחים בבקשה ושמותם מדויקים כדי להבטיח שהשירות יעבוד כמצופה.
על מנת לבדוק את תקינות הפרמטרים, ניתן להשתמש בכלי בדיקה כמו Postman או CURL.
מקווה שמדריך זה עוזר לך להתחיל לעבוד עם ה-API בהצלחה!