מדריך API: הוספת מיקום
הקדמה
שירות זה מאפשר להוסיף מיקום מותר לדיווח חדש למערכת באמצעות קריאה לנקודת הקצה המתוארת להלן.
URL
https://412.co.il/index.php/api/add_location
שיטת קריאה
POST
פרמטרים נדרשים
| פרמטר | תיאור | סוג | דוגמה |
|---|---|---|---|
name |
שם המיקום | מחרוזת | mylocation1 |
radius |
רדיוס המיקום המותר | מספר (נקודה צפה) | 0.1 (100 מטר), 0.5 (500 מטר), 1 (1 ק"מ) |
lat |
קו רוחב של המיקום | מספר (נקודה צפה) | 30.0001 |
lng |
קו אורך של המיקום | מספר (נקודה צפה) | 30.003 |
client |
מזהה הלקוח | מספר | 112 |
תגובה
התשובה משרת ה-API תהיה בפורמט JSON וכוללת את המידע הבא:
| פרמטר | תיאור | סוג |
|---|---|---|
status |
מצב ההצלחה של הפעולה | בוליאני (True/False) |
דוגמה לבקשת 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 בהצלחה!
הערות
0 הערות
היכנס למערכת כדי להגיב.