GPS-Trace Platform API क्या है?
Platform API रजिस्टर्ड GPS-Trace Console उपयोगकर्ताओं के लिए एक सॉफ़्टवेयर इंटरफ़ेस है। यह CRM, बिलिंग, या रिपोर्टिंग टूल्स जैसे बाहरी सिस्टम्स को GPS-Trace डेटा रिक्वेस्ट करने और Console की कुछ चुनी हुई ऑपरेशन्स करने की सुविधा देता है।
API में users, client plans, units, billing data, statistics, और reports के साथ काम करने के लिए methods शामिल हैं।
मैं API requests को authenticate कैसे करूं?
API requests को API token से authenticate किया जाता है। token, GPS-Trace Console में जनरेट की गई एक access key होती है। इसे हर request में शामिल करना ज़रूरी है, ताकि प्लेटफ़ॉर्म यह चेक कर सके कि उपयोगकर्ता के लिए कौन-कौन से actions allowed हैं।
token को X-AccessToken request header में भेजा जाता है।
कौन-कौन से API method groups उपलब्ध हैं?
API में निम्न method groups शामिल हैं:
- Account data methods
- Company data methods
- Client plan methods
- Unit methods
- User methods
- Billing data methods
- Statistics and report methods
मैं API के जरिए users के साथ कैसे काम कर सकता/सकती हूं?
Platform API users के साथ काम करने के लिए methods प्रदान करता है। उपलब्ध permissions के आधार पर, Console उपयोगकर्ता user records बना सकते हैं, user data अपडेट कर सकते हैं, और client plans, modules, तथा permissions असाइन कर सकते हैं।
Account data methods कैसे काम करते हैं?
Account सेक्शन में account data को create, read, update, और delete करने के methods शामिल हैं। इन actions को अक्सर CRUD operations कहा जाता है।
- एक account बनाएं
- एक account डिलीट करें
- account data अपडेट करें
- account data प्राप्त करें
जब कोई client account बनाया जाता है, तो request में वह application भी शामिल की जा सकती है जिसे account को असाइन किया जाना चाहिए। यह reg_apps field के जरिए किया जाता है। उपलब्ध applications उपयोगकर्ता के access level और agreement terms पर निर्भर करती हैं।
User records, client account के साथ ही बनाए जाते हैं और activation process पूरा होने तक inactive रहते हैं।
Account को activate करने के लिए:
- Console उपयोगकर्ता client को activation link भेजता है।
- client लिंक खोलकर email address और password दर्ज करता है।
- client, email confirmation link के जरिए registration की पुष्टि करता है।
- confirmation के बाद, assigned application, plan, और permissions के अनुसार user account active हो जाता है।
क्या इस API का इस्तेमाल सीधे vehicles को track करने के लिए किया जाता है?
यह API GPS-Trace Console operations और बाहरी सिस्टम्स के साथ data exchange के लिए है। यह Forguard मोबाइल application या अन्य GPS-Trace tracking interfaces का replacement नहीं है।
Console उपयोगकर्ता अपने access level के अनुसार API का उपयोग units, client plans, statistics, history, CRM systems, और billing systems के साथ काम करने के लिए कर सकते हैं।
API का इस्तेमाल किन कामों के लिए किया जा सकता है?
Platform API का उपयोग GPS-Trace को CRM, billing, reporting, या internal systems से कनेक्ट करने के लिए किया जा सकता है।
उदाहरण के लिए, Console उपयोगकर्ता unit data प्राप्त कर सकते हैं, client plans के साथ काम कर सकते हैं, statistics export कर सकते हैं, और external workflows में बार-बार होने वाले manual actions को कम कर सकते हैं।
क्या मैं API के जरिए historical tracking data एक्सेस कर सकता/सकती हूं?
हां, Platform API उपलब्ध methods और permissions के आधार पर historical tracking data तक access प्रदान कर सकता है।
उदाहरण के लिए, GET /partner/units/{id}/messages method किसी unit से messages प्राप्त करता है। प्राप्त किए जा सकने वाले messages की अधिकतम संख्या 10,000 है। आप यह भी specify कर सकते हैं कि आप कितने recent messages प्राप्त करना चाहते हैं।
पिछले 10 messages पाने के लिए example request:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
response में fields, tracking device द्वारा भेजे गए parameters पर निर्भर करते हैं।
मैं telemetry data कैसे प्राप्त करूं?
किसी unit के लिए नवीनतम telemetry data पाने के लिए GET /partner/units/{id}/telemetry method का उपयोग करें। response में निर्दिष्ट unit के लिए उपलब्ध latest telemetry message शामिल होता है। सटीक fields, tracking device द्वारा भेजे गए data पर निर्भर करते हैं।
Example request:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
मैं API के साथ शुरुआत कैसे करूं?
API access रिक्वेस्ट करने के लिए बस अपने Console account में sign in करें। अगर आपके पास नहीं है, तो आप यहां sign up भी कर सकते हैं।