Opouštíte nás, aniž byste si přečetli 10 tipů, jak ušetřit na správě vozového parku?
Zanechte nám svůj e-mail a my vám zašleme e-book na pozdější čtení.
GPS Dozor API
Dokumentace k webové službě GPS Dozor 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://a1.gpsguard.eu/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í:
Login: api_gpsdozor
Heslo: yakmwlARdn
Vybrat si můžete z těchto metod:
1) Získat dostupné skupiny
Vrací seznam skupin, na které má uživatel práva.
[{"Code":"SAGU","Name":"GPS Dozor - DEMO"}]2) Získat seznam vozidel v dané skupině
https://a1.gpsguard.eu/api/v1/vehicles/group/<group code>např.: https://a1.gpsguard.eu/api/v1/vehicles/group/SAGU
Vrací seznam vozidel, jejich jména, SPZ, stav baterie (0 jestli se baterie nepoužívá), rychlost, GPS pozici a čas poslední odezvy (UTC).
[{ "Code": "CELIRASUME", "GroupCode": "SATD", "BranchId": "51", "BranchName": "Pobocka 1", "Name": "Mercedes-Benz", "SPZ": "4EG 34-55", "BatteryPercentage": 0, "Speed": 86, "LastPosition": { "Latitude": "49.768475", "Longitude": "13.649925" }, "LastPositionTimestamp": "2018-02-09T15:25:34Z", "LastEngineRelayEvent": "2018-02-01T00:00:00Z", "EngineRelayState": 0, "Odometer": 332969827 "RefuelingCards": ["Card1", "Card2"]},{ "Code": "OBEHEHUGOV", "GroupCode": "SATD", "Name": "Package", "SPZ": "", "BatteryPercentage": 0, "Speed": 106, "LastPosition": { "Latitude": "43.664915", "Longitude": "-97.760474" }, "LastPositionTimestamp": "2018-02-09T15:26:11Z", "LastEngineRelayEvent": "2018-02-01T00:00:00Z", "EngineRelayState": 0, "Odometer": 332969827 "RefuelingCards": ["Card3", "Card4"]},...]3) Získat aktuální informace o daném vozidlu
https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>např.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU
Vrací aktuální informace o daném vozidlu.
{ "Code": "ZODIDOZEBU", "GroupCode": "SATD", "BranchId": "51", "BranchName": "Pobocka 1", "Name": "Mercedes-Benz", "SPZ": "4EG 34-55", "BatteryPercentage": 0, "Speed": 4, "LastPosition": { "Latitude": "49.7581", "Longitude": "13.617875" }, "LastPositionTimestamp": "2018-02-09T15:27:51Z", "Odometer": 332969827 "RefuelingCards": ["Card1", "Card2"]}4) Získat historii pozic daného vozidla
https://a1.gpsguard.eu/api/v1/vehicles/history/<coma separated vehicle codes>?from=<date+time from>&to=<date+time to>Vrací seznam pozic ve vybraném intervalu.
[{ "Name": "MAN", "VehicleCode": "ZODIDOZEBU", "From": "2017-07-19T22:00:00Z", "To": "2017-07-20T22:00:00Z", "Positions": [{ "Lat": "49.429325", "Lng": "12.012025", "Time": "2017-07-19T22:00:04Z", "Speed": 84 }, { "Lat": "49.425525", "Lng": "12.0049", "Time": "2017-07-19T22:00:31Z", "Speed": 90 }, }, { "Lat": "49.422525", "Lng": "12.0003", "Time": "2017-07-19T22:00:51Z", "Speed": 83 }, ... { "Lat": "49.3991", "Lng": "11.936325", "Time": "2017-07-19T22:05:11Z", "Speed": 82 }]}]5) Získat historické jízdy (knihu jízd)
https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>/trips?from=<date+time from>&to=<date+time to>např.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/trips?from=2018-05-20T00:00&to=2018-05-21T00: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, účel jízdy, jméno řidiče, ChipCode řidiče, jméno druhého řidiče, ChipCode druhého řidiče.
[{ "AverageSpeed": 74, "MaxSpeed": 98, "TripType": false, "StartTime": "2017-07-20T01:19:19", "FinishTime": "2017-07-20T03:46:53", "StartPosition": { "Latitude": "49.174525", "Longitude": "9.9951" }, "FinishPosition": { "Latitude": "49.4903", "Longitude": "7.954725" }, "StartAddress": "", "FinishAddress": "", "TripLength":" 02:27", "TripWaitingTime": "00:00", "TotalDistance": 181.274 "Purpose": "Pick-up delivery"},{ "AverageSpeed": 81, "MaxSpeed": 99, "TripType": false, "StartTime": "2017-07-20T03:51:17", "FinishTime": "2017-07-20T05:18:25", "StartPosition": { "Latitude": "49.490175", "Longitude": "7.954" }, "FinishPosition": { "Latitude": "49.13425", "Longitude": "6.546075" }, "StartAddress": "", "FinishAddress": "", "TripLength":" 01:27", "TripWaitingTime": "00:00", "TotalDistance": 118.021 "DriverName": "Doe, John", "DriverChipCode": "", "Driver2Name": "Jump, Bob", "Driver2ChipCode": "6734567890123466", "Odometer": 2000, "FuelConsumed": { "Value": 0.12141838466142181, "VolumeUnit": 0 }, "TripCost": { "Value":1.45702061593706400, "Currency": 0 }},...]Hodnoty výčtových typů:
VolumeUnit{ Litre = 0, UsGallon = 1, UkGallon = 2}Currency{ CZK = 0, EUR = 1, USD = 2, PLN = 3, HUF = 4, BGN = 5, BRL = 6, BYR = 7, CAD = 8, CHF = 9, ...}6) Získat informace o stavu zastavení vozidla
https://a1.gpsguard.eu/api/v1/vehicle//getEngineRelayStatenapř.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/getEngineRelayState
Vrací informaci o stavu zastavení vozidla.
{ "RelayState": 0, "LastEventTimestamp": "2018-04-23T16:17:31.0621104+02:00"}Hodnoty stavů:
0 - počáteční stav1 - požadavek na zastavení vozidla odeslán, nepotvrzen2 - požadavek na zastavení vozidla odeslán, potvrzen systémem3 - požadavek na zrušení zastavení vozidla odeslán, nepotvrzen4 - požadavek na zrušení zastavení vozidla odeslán, potvrzen systémem5 - nelze zastavit vozidlo, žádost zamítnuta nebo zpožděna7) Nastavit stav zastavení vozidla
https://a1.gpsguard.eu/api/v1/vehicle//setEngineRelayState/<on or off>např.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/setEngineRelayState/off posílá požadavek na zastavení vozidla do zařízení
nebo
https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/setEngineRelayState/on posílá požadavek na zrušení zastavení vozidla do zařízení
Vrací aktuální informaci o stavu zastavení vozidla.
{ "RelayState": 1, "LastEventTimestamp": "2018-04-23T16:17:31.0621104+02:00"}Poznámka: používejte getEnginerRelayState k ověření aktuálního stavu na zařízení
8) Restartovat funkci zastavení vozidla
https://a1.gpsguard.eu/api/v1/vehicle//resetEngineRelayStatenapř.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/resetEngineRelayState - restartuje stav zastavení vozidla v systému na počáteční stav 0, do zařízení se neodesí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": "2018-04-23T16:17:31.0621104+02:00"}9) Získat data ze senzorů
https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>/sensors/Rpm?from=<date+time from>&to=<date+time to>např.: https://a1.gpsguard.eu/api/v1/vehicle/AFOSINARAS/sensors/Rpm,Speed?from=2021-01-25T07:25&to=2021-01-25T07:30 - vrací data ze senzoru otáček za minutu a senzoru rychlosti pro vybraný interval a určené vozidlo
Dostupné typy senzorů (v závislosti na konfiguraci vozidla a zařízení):
- Temperature1
- Temperature2
- Temperature3
- Temperature4
- InternalBatteryPercentage
- InternalBatteryVoltage
- ExternalBatteryPercentage
- ExternalBatteryVoltage
- Speed
- Altitude
- Rpm
- Odometer
- ThrottlePercentage
- FuelConsumedTotal
- FuelConsumptionActual
- FuelActualVolume
- FuelActualVolumeFromPercentage
- Humidity1
- Humidity2
- Humidity3
- Humidity4
- LightSensor
- CoolingLiquidTemperature
- EngineTemperature
- BinaryInput1
- BinaryInput2
- BinaryInput3
- BinaryInput4
- AnalogInput1
- AnalogInput2
- AnalogInput3
{ "items": [ { "name": "Rpm", "units": "int", "data": [ { "t": "2020-05-26T15:02:49Z", "v": 827 }, { "t": "2020-05-26T15:04:47Z", "v": 0 } ] }, { "name": "Speed", "units": "KilometersPerHour", "data": [ { "t": "2020-05-26T15:02:49Z", "v": 10.0 }, { "t":" 2020-05-26T15:04:47Z", "v": 13.0 } ] } ]}10) Získat data pro Eco driving
https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>/eco-driving-events?from=<date+time from>&to=<date+time to>např.: https://a1.gpsguard.eu/api/v1/vehicle/AFOSINARAS/eco-driving-events?from=2021-03-01T00:00&to=2021-03-02T00:00 - vrací data událostí pro styl jízdy, pro vybraný interval a určené vozidlo
{ "EventType": 4, "EventValue": 100, "Timestamp": "2017-07-20T08:59:33", "Position": { "Latitude": 50.153774, "Longitude": 14.51775 }, "EventSeverity": 0, "Speed": 20}Hodnoty výčtových typů:
EventType{ Unknown = 0, CorneringLeft = 1, CorneringRight = 2, Cornering = 3, Acceleration = 4, Braking = 5, Bump = 6, LongClutch = 7, DriveOnNeutral = 8, LongFreeWheel = 9}EventSeverity{ None = 0, Low = 1, Medium = 2, High = 3,}11) Změna pobočky pro vozidlo
PUT https://a1.gpsguard.eu/api/v1/vehicle/change-branchZmění pobočku pro dané vozidlo. Prametry pro změnu se posílají v těle requestu.
Tělo requestu:
{ "VehicleCode": "CELIRASUME", "BranchId": 1}12) Změna pobočky pro vozidlo dle názvu pobočky
PUT https://a1.gpsguard.eu/api/v1/vehicle/change-branch-by-nameZmění pobočku pro dané vozidlo. Prametry pro změnu se posílají v těle requestu. Pobočky v dané skupině musí mít unikátní název.
Tělo requestu:
{ "VehicleCode": "CELIRASUME", "BranchName": "Pobocka 1"}13) Získat pobočky ve skupině
GET https://a1.gpsguard.eu/api/v1/groups/{groupCode}/branchesnapř.: https://a1.gpsguard.eu/api/v1/groups/sagu/branches - vrací seznam poboček pro danou skupinu
14) Změna účelu jízdy
POST https://a1.gpsguard.eu/api/v1/trip-purposesNastaví účel jízdy pro dané vozidlo. Účel jízdy se poté zobrazuje u všech jízd tohoto vozidla. Účel jízdy je platný od chvíle, kdy je vytvořen, do doby, než je nahrazen novým. Parametry pro jeho nastavení se posílají v těle requestu.
Tělo requestu:
{ "VehicleCode": "EVICIKEJIT", "Purpose": "hezka jizda"}15) Změna tankovacích karet
Přepíše tankovací karty pro dané vozidlo. Prametry pro změnu se posílají v těle requestu.
Tělo requestu:
{ "refuelingCards": [ "123444", "1111111", "19839839848949849", "704310 08887300296", "0F97CB92", "0A907354" ]},V případě chyby vrátí stavový kód 409 Conflict.
Nedojde k naimportování žádné karty a vrací se Dictionary. Klíč je vehicleCode vozidla a hodnoty jsou čísla karet, která už jsou přiřazena k jiným vozidlům.