Kas yra GPS-Trace Platform API?
Platform API – tai programinės sąsajos (API) sprendimas registruotiems GPS-Trace Console naudotojams. Jis leidžia išorinėms sistemoms, tokioms kaip CRM, atsiskaitymų (billing) ar ataskaitų įrankiai, užklausti GPS-Trace duomenis ir atlikti pasirinktas Console operacijas.
API apima metodus darbui su naudotojais, klientų planais, objektais, atsiskaitymų duomenimis, statistika ir ataskaitomis.
Kaip autentifikuoti API užklausas?
API užklausos autentifikuojamos naudojant API žetoną (token). Žetonas – tai prieigos raktas, sugeneruotas GPS-Trace Console. Jis turi būti įtrauktas į kiekvieną užklausą, kad platforma galėtų patikrinti, kokie veiksmai yra leidžiami naudotojui.
Žetonas siunčiamas X-AccessToken užklausos antraštėje (header).
Kokios API metodų grupės yra prieinamos?
API apima šias metodų grupes:
- Paskyros duomenų metodai
- Įmonės duomenų metodai
- Kliento plano metodai
- Objekto metodai
- Naudotojų metodai
- Atsiskaitymų duomenų metodai
- Statistikos ir ataskaitų metodai
Kaip per API dirbti su naudotojais?
Platform API suteikia metodus darbui su naudotojais. Priklausomai nuo turimų teisių, Console naudotojai gali kurti naudotojų įrašus, atnaujinti naudotojų duomenis ir priskirti klientų planus, modulius bei teises.
Kaip veikia paskyros duomenų metodai?
Paskyros (account) skiltyje yra metodai, skirti paskyros duomenims kurti, skaityti, atnaujinti ir trinti. Šie veiksmai dažnai vadinami CRUD operacijomis.
- Sukurti paskyrą
- Ištrinti paskyrą
- Atnaujinti paskyros duomenis
- Gauti paskyros duomenis
Kai kuriama kliento paskyra, užklausoje galima nurodyti programą, kuri turi būti priskirta paskyrai. Tai atliekama per lauką reg_apps. Prieinamos programos priklauso nuo naudotojo prieigos lygio ir Agreement sąlygų.
Naudotojų įrašai sukuriami kartu su kliento paskyra ir lieka neaktyvūs, kol nebaigiamas aktyvavimo procesas.
Norint aktyvuoti paskyrą:
- Console naudotojas klientui išsiunčia aktyvavimo nuorodą.
- Klientas paspaudžia nuorodą ir įveda el. pašto adresą bei slaptažodį.
- Klientas patvirtina registraciją per el. laiške esančią patvirtinimo nuorodą.
- Po patvirtinimo naudotojo paskyra tampa aktyvi pagal priskirtą programą, planą ir teises.
Ar šis API skirtas tiesiogiai transporto priemonėms sekti?
API skirtas GPS-Trace Console operacijoms ir duomenų mainams su išorinėmis sistemomis. Jis nepakeičia Forguard mobiliosios programėlės ar kitų GPS-Trace sekimo sąsajų.
Console naudotojai gali taikyti API darbui su objektais, klientų planais, statistika, istorija, CRM sistemomis ir atsiskaitymų sistemomis – priklausomai nuo turimo prieigos lygio.
Kam galima naudoti API?
Platform API galima naudoti GPS-Trace sujungti su CRM, atsiskaitymų (billing), ataskaitų teikimo ar vidinėmis sistemomis.
Pavyzdžiui, Console naudotojai gali gauti objektų duomenis, dirbti su klientų planais, eksportuoti statistiką ir sumažinti pasikartojančius rankinius veiksmus išoriniuose procesuose.
Ar per API galiu pasiekti istorinius sekimo duomenis?
Taip, Platform API gali suteikti prieigą prie istorinių sekimo duomenų – priklausomai nuo prieinamų metodų ir teisių.
Pavyzdžiui, metodas GET /partner/units/{id}/messages grąžina objekto pranešimus. Maksimalus pranešimų skaičius, kurį galima gauti, yra 10 000. Taip pat galite nurodyti, kiek naujausių pranešimų norite gauti.
Pavyzdinė užklausa paskutiniams 10 pranešimų gauti:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Atsakyme pateikiami laukai priklauso nuo parametrų, kuriuos siunčia sekimo įrenginys.
Kaip galiu gauti telemetrijos duomenis?
Norėdami gauti naujausius objekto telemetrijos duomenis, naudokite metodą GET /partner/units/{id}/telemetry. Atsakyme pateikiamas naujausias telemetrijos pranešimas, prieinamas nurodytam objektui. Tikslūs laukai priklauso nuo to, kokius duomenis siunčia sekimo įrenginys.
Pavyzdinė užklausa:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Kaip pradėti naudotis API?
Norėdami paprašyti API prieigos, tiesiog prisijunkite prie savo Console account. Jei jo neturite, taip pat galite užsiregistruoti čia.