מהו GPS-Trace Platform API?
Platform API הוא ממשק תוכנה עבור משתמשי GPS-Trace Console רשומים. הוא מאפשר למערכות חיצוניות, כגון CRM, חיוב או כלי דיווח, לבקש נתונים מ‑GPS-Trace ולבצע פעולות נבחרות ב‑Console.
ה‑API כולל שיטות לעבודה עם משתמשים, תוכניות לקוח, יחידות, נתוני חיוב, סטטיסטיקות ודוחות.
איך מאמתים בקשות API?
בקשות API מאומתות באמצעות אסימון API (API token). אסימון הוא מפתח גישה שנוצר ב‑GPS-Trace Console. יש לכלול אותו בכל בקשה כדי שהפלטפורמה תוכל לבדוק אילו פעולות מותרות למשתמש.
האסימון נשלח בכותרת הבקשה X-AccessToken.
אילו קבוצות שיטות API זמינות?
ה‑API כולל את קבוצות השיטות הבאות:
- שיטות לנתוני חשבון
- שיטות לנתוני חברה
- שיטות לתוכניות לקוח
- שיטות ליחידות
- שיטות למשתמשים
- שיטות לנתוני חיוב
- שיטות לסטטיסטיקות ודוחות
איך אפשר לעבוד עם משתמשים דרך ה‑API?
ה‑Platform API מספק שיטות לעבודה עם משתמשים. בהתאם להרשאות הזמינות, משתמשי Console יכולים ליצור רשומות משתמש, לעדכן נתוני משתמש, ולהקצות תוכניות לקוח, מודולים והרשאות.
איך עובדות שיטות נתוני חשבון?
מקטע החשבון כולל שיטות ליצירה, קריאה, עדכון ומחיקה של נתוני חשבון. פעולות אלה מכונות לעיתים קרובות CRUD.
- יצירת חשבון
- מחיקת חשבון
- עדכון נתוני חשבון
- שליפת נתוני חשבון
כאשר נוצר חשבון לקוח, הבקשה יכולה לכלול את היישום שיש להקצות לחשבון. הדבר נעשה באמצעות השדה reg_apps. היישומים הזמינים תלויים ברמת הגישה של המשתמש ובתנאי ההסכם.
רשומות משתמש נוצרות יחד עם חשבון הלקוח והן אינן פעילות עד להשלמת תהליך ההפעלה.
כדי להפעיל את החשבון:
- משתמש Console שולח ללקוח קישור הפעלה.
- הלקוח נכנס לקישור ומזין כתובת דוא״ל וסיסמה.
- הלקוח מאשר את ההרשמה באמצעות קישור האימות שמתקבל בדוא״ל.
- לאחר האישור, חשבון המשתמש הופך לפעיל בהתאם ליישום שהוקצה, לתוכנית ולהרשאות.
האם ה‑API הזה משמש למעקב אחרי כלי רכב ישירות?
ה‑API מיועד לפעולות ב‑GPS-Trace Console ולהחלפת נתונים עם מערכות חיצוניות. הוא אינו תחליף לאפליקציה הניידת Forguard או לממשקי מעקב אחרים של GPS-Trace.
משתמשי Console יכולים להשתמש ב‑API לעבודה עם יחידות, תוכניות לקוח, סטטיסטיקות, היסטוריה, מערכות CRM ומערכות חיוב — בהתאם לרמת הגישה שלהם.
למה אפשר להשתמש ב‑API?
ניתן להשתמש ב‑Platform API כדי לחבר את GPS-Trace ל‑CRM, חיוב, דיווח או מערכות פנימיות.
לדוגמה, משתמשי Console יכולים לשלוף נתוני יחידה, לעבוד עם תוכניות לקוח, לייצא סטטיסטיקות ולהפחית פעולות ידניות חוזרות בתהליכי עבודה חיצוניים.
האם אפשר לגשת לנתוני מעקב היסטוריים דרך ה‑API?
כן, ה‑Platform API יכול לספק גישה לנתוני מעקב היסטוריים, בהתאם לשיטות ולהרשאות הזמינות.
לדוגמה, השיטה GET /partner/units/{id}/messages שולפת הודעות מיחידה. מספר ההודעות המקסימלי שניתן לשלוף הוא 10,000. ניתן גם לציין כמה הודעות אחרונות ברצונכם לקבל.
דוגמת בקשה לקבלת 10 ההודעות האחרונות:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
השדות בתגובה תלויים בפרמטרים שנשלחים על ידי מכשיר המעקב.
איך אפשר לשלוף נתוני טלמטריה?
כדי לקבל את נתוני הטלמטריה העדכניים ביותר עבור יחידה, השתמשו בשיטה GET /partner/units/{id}/telemetry. התגובה מכילה את הודעת הטלמטריה העדכנית ביותר הזמינה עבור היחידה שצוינה. השדות המדויקים תלויים בנתונים שנשלחים על ידי מכשיר המעקב.
דוגמת בקשה:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
איך מתחילים לעבוד עם ה‑API?
כדי לבקש גישה ל‑API, פשוט התחברו אל חשבון ה‑Console שלכם. אם אין לכם חשבון, תוכלו גם להירשם כאן.