api-dokumentace

Dokumentace API - GPS Force

Kompletní dokumentace k webové službě GPS Force JSON API. Díky API získáte přístup k datům v reálném čase.

API je k dispozici na adrese https://api.gpsforce.cz/api/v1/

Přihlašovací údaje jsou stejné jako pro přihlášení do systému. Používá se Basic authentication pomocí protokolu HTTPS.

Demo přístupy pro vyzkoušení

Heslo: DS5FSpbUmn

Výběr z těchto metod:

Získání dostupné skupiny

https://api.gpsforce.cz/api/v1/groups

Vrací seznam skupiny, na které má uživatel nastavené práva

[{"Code":"AZIT","Name":"GPS FORCE CZ DEMO"}]

Získání seznamu vozidel v dané skupině

https://api.gpsforce.cz/api/v1/vehicles/group/<group code>

např.: https://api.gpsforce.cz/api/v1/vehicles/group/AZIT

Vrací seznam vozidel, jejich jména, SPZ, stav baterie (0 jestli se baterie nepoužívá), rychlost, GPS pozici a čas poslední odezvy (UTC).

{

"Code":"ASAFOVOFUM

","GroupCode":"AZIT

","BranchName":"Mladá Boleslav

","Name":"Škoda Octavia

","SPZ":"3SH 3623

","BatteryPercentage":0

,"Speed":45.0

"LastPosition"{"Latitude":"50.03483

","Longitude":"15.7469

"},"DeviceImei":"AZIT_1

","IsActive":true,

"LastPositionTimestamp":"2020-05-11T18:47:24Z"},

{"Code":"MIDIFUGIZU

","GroupCode":"AZIT

","BranchName":"Obchodní oddělení

","Name":"Škoda Kodiaq

","SPZ":"2H7 7896

","BatteryPercentage":0

,"Speed":85.0

,"LastPosition{"Latitude":"49.72998

","Longitude":"13.3608"}

,"DeviceImei":"AZIT_2

","IsActive":true,

"LastPositionTimestamp":"2020-05-11T19:40:01Z"

Získání informací o daném vozidlu

https://api.gpsforce.cz/api/v1/vehicle/<vehicle code>

např.: https://api.gpsforce.cz/api/v1/vehicle/ASAFOVOFUM

Vrací aktuální infomace o daném vozidlu

{

"Code":"ASAFOVOFUM

","GroupCode":"AZIT

","BranchName

":"Mladá Boleslav

","Name

":"Škoda Octavia

","SPZ":"3SH 3623

","BatteryPercentage

":0,"Speed":45.0,

"LastPosition":{"Latitude":"50.03483","Longitude":"15.7469"},

"DeviceImei

":"AZIT_1","IsActive

":true,"LastPositionTimestamp

":"2020-05-11T18:47:24Z"

}

Získání historie pozic k danému vozidlu

https://api.gpsforce.cz/api/v1/vehicles/history/<coma separated vehicle codes>?from=<date+time from>&to=<date+time to>

např.: https://api.gpsforce.cz/api/v1/vehicles/history/ASAFOVOFUM?from=2019-05-20T00:00&to=2019-05-21T00:00

Vrací seznam pozic ve vybraném intervalu

[{"Name":"Škoda Octavia","VehicleCode":"ASAFOVOFUM","From":"2019-05-19T22:00:00Z","To":"2019-05-20T22:00:00Z","Positions":[{"Lat":"48.99354","Lng":"14.48653","Time":"2019-05-19T23:10:10Z","Speed":0.0},{"Lat":"48.99354","Lng":"14.48653","Time":"2019-05-20T00:39:31Z","Speed":0.0},{"Lat":"48.99286","Lng":"14.48586","Time":"2019-05-20T00:39:35Z","Speed":78.0},

Získání knihy jízd k danému vozidlu

https://api.gpsforce.cz/api/v1/vehicle/<vehicle code>/trips?from=<date+time from>&to=<date+time to>

např.: https://api.gpsforce.cz/api/v1/vehicle/ASAFOVOFUM/trips?from=2020-05-12T00:00&to=2020-05-13T00:00

Vrací seznam jízd daného vozidla s podrobnými informacemi za vybrané období. Průměrná rychlost, max. rychlost, typ jízdy, začátek/konec jízdy, počáteční/koncová pozice, počáteční/koncová adresa, čas jízdy, čas stání, délka jízdy.

[

{

"AverageSpeed":65.0,

"MaxSpeed":99.0,

"TripType":false,

"StartTime":"2020-05-12T08:26:54

","FinishTime":"2020-05-12T09:34:03

","StartPosition":{"Latitude":"50.03467

","Longitude":"15.74713"},

"FinishPosition":{"Latitude":"50.11877

","Longitude":"15.165482"},

"StartAddress":"37, 530 02 Pardubice I, CZ

","FinishAddress":"D11, 289 07 Libice nad Cidlinou, CZ","TripLength":"01:07

","TripWaitingTime":"00:00

","TotalDistance":72.269

,"DriverName":"Novák, Karel

","DriverChipCode"23135498

}

Získání informace o stavu funkce zastavení vozidla

https://api.gpsforce.cz/api/v1/vehicle/<vehicle code>/getEngineRelayState

např.: https://api.gpsforce.cz/api/v1/vehicle/ASAFOVOFUM/getEngineRelayState

Vrací informaci o stavu zastavení vozidla

{

"RelayState":1,"LastEventTimestamp":"2020-05-13T11:22:00"

}

Hodnoty stavů

0 - počáteční stav

1 - požadavek na zastavení vozidla odeslán, nepotvrzen

2 - požadavek na zastavení vozidla odeslán, potvrzen systémem

3 - požadavek na zrušení zastavení vozidla odeslán, nepotvrzen

4 - požadavek na zrušení zastavení vozidla odeslán, potvrzen systémem

5 - nelze zastavit vozidlo, žádost zamítnuta nebo zpožděna

Nastavit stav zastavení vozidla

https://api.gpsforce.cz/api/v1/vehicle/<vehicle code>/setEngineRelayState/<on or off>

např.: https://api.gpsforce.cz/api/v1/vehicle/ASAFOVOFUM/setEngineRelayState/off odešle požadavek na vypnutí funkce startování

např.: https://api.gpsforce.cz/api/v1/vehicle/ASAFOVOFUM/setEngineRelayState/on odešle požadavek na zapnutí funkce startování

Vrací aktuální informaci o stravu zastavení vozidla

{

"RelayState":1,"LastEventTimestamp":"2020-05-13T11:22:00"

}

Poznámka: používejte getEnginerRelayState k ověření aktuálního stavu na zařízení

Restartování funkce blokace startování

https://api.gpsforce.cz/api/v1/vehicle/<vehicle code>/resetEngineRelayState

např.: https://api.gpsforce.cz/api/v1/vehicle/ASAFOVOFUM/resetEngineRelayState restartuje stav blokace startování vozidla do systému na počáteční hodnotu 0, do zařízení se neposílá žádný příkaz

Upozornění: Může způsobit nesrovnalosti mezi stavem zobrazeným v systému a skutečným stavem vozidla! Použijte pouze tehdy, pokud jste si jisti, že je skutečné vozidlo odblokováno a stav v systému je nesprávný.

Vrací aktuální informaci o stavu zastavení vozidla.

{

"RelayState":0,"LastEventTimestamp":"2020-05-13T11:25:00"

}