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/

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":"ZODIDOZEBU",
      "GroupCode":"SAGU",
      "Name":"MAN",
      "SPZ":"",
      "BatteryPercentage":0,
      "Speed":1.0,
      "LastPosition":{
         "Latitude":"25.767524",
         "Longitude":"-80.193646"
      },
      "LastPositionTimestamp":"2018-03-23T00:48:14"
   },
   {
      "Code":"ERATINUSAT",
      "GroupCode":"SAGU",
      "Name":"Scania 1",
      "SPZ":"",
      "BatteryPercentage":0,
      "Speed":0.0,
      "LastPosition":{
         "Latitude":"27.873273",
         "Longitude":"-81.020683"
      },
      "LastPositionTimestamp":"2018-04-05T21:32:04Z"
   },
   ...
]

3) Získat aktuální informace o daném vozidlu

https://a1.gpsguard.eu/api/v1/vehicle/

např.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU

Vrací aktuální informace o daném vozidlu.

{
 "Code": "ZODIDOZEBU",
 "GroupCode": "SAGU",
 "Name": "MAN",
 "SPZ": "",
 "BatteryPercentage": 10,
 "Speed": 4,
 "LastPosition": {
      "Latitude":"27.873273",
      "Longitude":"-81.020683"
 },
 "LastPositionTimestamp": "2018-02-09T15:27:51Z"
}

4) Získat historii pozic daného vozidla

https://a1.gpsguard.eu/api/v1/vehicles/history/?from=&to=

např.: https://a1.gpsguard.eu/api/v1/vehicles/history/ZODIDOZEBU,ERATINUSAT?from=2018-05-20T00:00&to=2018-05-21T00:00

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":"28.321751",
            "Lng":"-80.715108",
            "Time":"2017-07-19T22:00:13Z",
            "Speed":82.0
         },
         {
            "Lat":"28.321395",
            "Lng":"-80.714849",
            "Time":"2017-07-19T22:00:16Z",
            "Speed":53.0
         },
         {
            "Lat":"28.321023",
            "Lng":"-80.714532",
            "Time":"2017-07-19T22:00:20Z",
            "Speed":53.0
         },
      ...
      ]
   }
]

5) Získat historické jízdy (knihu jízd)

https://a1.gpsguard.eu/api/v1/vehicle//trips?from=&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.

[
   {
      "AverageSpeed":63.0,
      "MaxSpeed":99.0,
      "TripType":false,
      "StartTime":"2017-07-19T23:40:55",
      "FinishTime":"2017-07-20T01:45:42",
      "StartPosition":{
         "Latitude":"28.05401",
         "Longitude":"-80.589111"
      },
      "FinishPosition":{
         "Latitude":"27.0705",
         "Longitude":"-80.482134"
      },
      "StartAddress":"I-95, Cocoa, FL 32926, US",
      "FinishAddress":"I-95, St. Augustine, FL 32084, US",
      "TripLength":"02:04",
      "TripWaitingTime":"00:00",
      "TotalDistance":131.159
   },
   {
      "AverageSpeed":66.0,
      "MaxSpeed":99.0,
      "TripType":false,
      "StartTime":"2017-07-20T02:04:49",
      "FinishTime":"2017-07-20T04:40:16",
      "StartPosition":{
         "Latitude":"27.0705",
         "Longitude":"-80.482134"
      },
      "FinishPosition":{
         "Latitude":"25.769416",
         "Longitude":"-80.239058"
      },
      "StartAddress":"Florida's Turnpike, Lake Worth, FL 33467, US",
      "FinishAddress":"Ronald Reagan Turnpike, Miami, FL 33182, US",
      "TripLength":"02:35",
      "TripWaitingTime":"00:00",
      "TotalDistance":170.498
   },
   ...
]

6) Získat informace o stavu zastavení vozidla

https://a1.gpsguard.eu/api/v1/vehicle//getEngineRelayState

např.: 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í 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

7) Nastavit stav zastavení vozidla

https://a1.gpsguard.eu/api/v1/vehicle//setEngineRelayState/

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//resetEngineRelayState

např.: 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"
}