Ano ang GPS-Trace Platform API?
Ang Platform API ay isang software interface para sa mga rehistradong gumagamit ng GPS-Trace Console. Pinapahintulutan nito ang mga external system, gaya ng CRM, billing, o mga reporting tool, na humiling ng data mula sa GPS-Trace at magsagawa ng piling operasyon sa Console.
Kasama sa API ang mga method para sa pagtatrabaho sa mga user, client plan, unit, billing data, statistics, at mga report.
Paano ko ia-authenticate ang mga API request?
Ang mga API request ay ina-authenticate gamit ang API token. Ang token ay isang access key na ginagawa (generated) sa GPS-Trace Console. Kailangan itong isama sa bawat request para ma-check ng platform kung aling mga aksyon ang pinapahintulutan para sa user.
Ipinapadala ang token sa request header na X-AccessToken.
Anong mga grupo ng API method ang available?
Kasama sa API ang mga sumusunod na grupo ng method:
- Mga method para sa account data
- Mga method para sa company data
- Mga method para sa client plan
- Mga method para sa unit
- Mga method para sa user
- Mga method para sa billing data
- Mga method para sa statistics at report
Paano ako makakapagtrabaho sa mga user sa pamamagitan ng API?
Nagbibigay ang Platform API ng mga method para sa pagtatrabaho sa mga user. Depende sa mga available na permission, puwedeng gumawa ng user record ang mga gumagamit ng Console, mag-update ng user data, at magtalaga ng client plan, mga module, at mga permission.
Paano gumagana ang mga method para sa account data?
Kasama sa seksyong account ang mga method para sa paglikha, pagbasa, pag-update, at pagbura ng account data. Ang mga aksyong ito ay madalas na tinatawag na CRUD operations.
- Gumawa ng account
- Magbura ng account
- I-update ang account data
- Kunin ang account data
Kapag gumagawa ng client account, puwedeng isama sa request ang application na dapat italaga sa account. Ginagawa ito sa pamamagitan ng field na reg_apps. Ang mga available na application ay nakadepende sa access level ng user at sa mga termino ng kasunduan.
Ang mga user record ay ginagawa kasabay ng client account at mananatiling inactive hanggang makumpleto ang activation process.
Para i-activate ang account:
- Nagpapadala ang Console user ng activation link sa client.
- Sinusundan ng client ang link at naglalagay ng email address at password.
- Kinukumpirma ng client ang registration sa pamamagitan ng email confirmation link.
- Pagkatapos ng kumpirmasyon, nagiging active ang user account ayon sa nakatalagang application, plan, at mga permission.
Ginagamit ba ang API na ito para direktang mag-track ng mga sasakyan?
Ang API ay nilayon para sa mga operasyon sa GPS-Trace Console at sa palitan ng data (data exchange) kasama ang mga external system. Hindi ito kapalit ng Forguard mobile application o ng iba pang GPS-Trace tracking interface.
Puwedeng gamitin ng mga gumagamit ng Console ang API para magtrabaho sa mga unit, client plan, statistics, history, CRM system, at billing system, depende sa kanilang access level.
Saan puwedeng gamitin ang API?
Puwedeng gamitin ang Platform API para ikonekta ang GPS-Trace sa CRM, billing, reporting, o mga internal system.
Halimbawa, puwedeng kunin ng mga gumagamit ng Console ang unit data, magtrabaho sa mga client plan, mag-export ng statistics, at mabawasan ang paulit-ulit na manual na gawain sa mga external workflow.
Makaka-access ba ako ng historical tracking data sa pamamagitan ng API?
Oo, puwedeng magbigay ang Platform API ng access sa historical tracking data, depende sa mga available na method at permission.
Halimbawa, kinukuha ng method na GET /partner/units/{id}/messages ang mga message mula sa isang unit. Ang maximum na bilang ng message na puwedeng makuha ay 10,000. Puwede mo ring tukuyin kung ilang pinakabagong message ang gusto mong matanggap.
Halimbawang request para kunin ang huling 10 message:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Ang mga field sa response ay nakadepende sa mga parameter na ipinadala ng tracking device.
Paano ko makukuha ang telemetry data?
Para makuha ang pinakabagong telemetry data para sa isang unit, gamitin ang method na GET /partner/units/{id}/telemetry. Naglalaman ang response ng pinakabagong telemetry message na available para sa tinukoy na unit. Ang eksaktong mga field ay nakadepende sa data na ipinadala ng tracking device.
Halimbawang request:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Paano ako magsisimula sa API?
Para humiling ng API access, mag-sign in lang sa iyong Console account. Kung wala ka pa nito, puwede ka ring mag-sign up dito.