GPS Dozor API

Dokumentácia k webovej službe GPS Dozor JSON API. Vďaka API získate prístup k dátam v reálnom čase.

API je k dispozícii na adrese https://a1.gpsguard.eu/api/v1/

Prihlasovacie údaje sú rovnaké ako pre prihlásenie do systému. Používa sa Basic authentication pomocou protokolu HTTPS.

Demo prístupy pre odskúšanie:
Login: api_gpsdozor
Heslo: yakmwlARdn

Vybrať si môžete z týchto metód:

1) Získať dostupné skupiny

Vracia zoznam skupín, na ktoré má užívateľ práva.

[{"Code":"SAGU","Name":"GPS Dozor - DEMO"}]

2) Získať zoznam vozidiel v danej skupine

https://a1.gpsguard.eu/api/v1/vehicles/group/<group code>

napr.: https://a1.gpsguard.eu/api/v1/vehicles/group/SAGU

Vracia zoznam vozidiel, ich mená, ŠPZ, stav batérie (0 ak sa batéria nepoužíva), rýchlosť, GPS pozíciu a čas poslednej odozvy (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ískať aktuálnu informáciu o danom vozidle

https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>

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

Vracia aktuálnu informáciu o danom vozidle.

{
 "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ískať históriu pozícií daného vozidla

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

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

Vracia zoznam pozícií vo vybranom intervale.

[
   {
      "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ískať historické jazdy (knihu jázd)

https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>/trips?from=<date+time from>&to=<date+time to>

napr.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/trips?from=2018-05-20T00:00&to=2018-05-21T00:00

Vracia zoznam jázd daného vozidla s podrobnými informáciami za vybrané obdobie. Priemerná rýchlosť, max. rýchlosť, typ jazdy, začiatok/koniec jazdy, počiatočná/koncová pozícia, počiatočná/koncová adresa, čas jazdy, čas státia, dĺžka jazdy.

[
   {
      "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,
      "DriverName":"Mikoláš, Karel",
      "DriverChipCode":"000000753DBF"
   },
   ...
]

6) Získať informácie o stave zastavenia vozidla

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

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

Vracia informáciu o stave zastavenia vozidla.

{
     "RelayState": 0,
     "LastEventTimestamp": "2018-04-23T16:17:31.0621104+02:00"
}

Hodnoty stavov:

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) Nastaviť stav zastavenia vozidla

https://a1.gpsguard.eu/api/v1/vehicle//setEngineRelayState/<on or off>

napr.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/setEngineRelayState/off posiela požiadavku na zastavenie vozidla do zariadenia

alebo

https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/setEngineRelayState/on posiela požiadavku na zrušenie zastavenia vozidla do zariadenie

Vracia aktuálnu informáciu o stave zastavenia vozidla.

{
     "RelayState": 1,
     "LastEventTimestamp": "2018-04-23T16:17:31.0621104+02:00"
}

Poznámka: používajte getEnginerRelayState k overeniu aktuálneho stavu na zariadení

8) Reštartovať funkciu zastavenia vozidla

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

napr.: https://a1.gpsguard.eu/api/v1/vehicle/ZODIDOZEBU/resetEngineRelayState - reštartuje stav zastavenia vozidla v systéme na počiatočný stav 0, do zariadenia sa neodosiela žiadny príkaz

Upozornenie: Môže spôsobiť nezrovnalosti medzi stavom zobrazeným v systéme a skutočným stavom vozidla! Použite iba vtedy, ak ste si istý, že je skutočne vozidlo odblokované a stav v systéme je nesprávny.

Vracia aktuálnu informáciu o stave zastavenia vozidla.

{
     "RelayState": 0,
     "LastEventTimestamp": "2018-04-23T16:17:31.0621104+02:00"
}

9) Získať dáta zo senzorov

https://a1.gpsguard.eu/api/v1/vehicle/<vehicle code>/sensors/Rpm?from=<date+time from>&to=<date+time to>

napr.: https://a1.gpsguard.eu/api/v1/vehicle/AFOSINARAS/sensors/Rpm,Speed?from=2021-01-25T07:25&to=2021-01-25T07:30 - vracia dáta zo senzoru otáčok za minútu a senzoru rýchlosti pre vybraný interval a určené vozidlo

Dostupné typy senzorov (v závislosti na konfigurácii vozidla a zariadenia):

  • 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
        }
      ]
    }
  ]
}