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": "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
},
{ 
  "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
},
...
]

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": "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
}

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": "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í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": 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
},
{ 
  "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": "",
  "Odometer": 2000,
  "FuelConsumed": { 
    "Value": 0.12141838466142181,
    "VolumeUnit": 0
  },
  "TripCost": { 
    "Value":1.45702061593706400,
    "Currency": 0
  }
},
...
]

Hodnoty stavov:

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

10) Získať dáta pre Eco driving

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

napr.: https://a1.gpsguard.eu/api/v1/vehicle/AFOSINARAS/eco-driving-events?from=2021-03-01T00:00&to=2021-03-02T00:00 - vracia dáta udalostí pre štýl jazdy, pre 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 vymenovaných typov:

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) Zmena pobočky pre vozidlo

PUT https://a1.gpsguard.eu/api/v1/vehicle/change-branch

Zmení pobočku pre dané vozidlo. Prametry pre zmenu sa posielajú v tele requestu.

Telo requestu:

{ 
  "VehicleCode": "CELIRASUME",
  "BranchId": 1
}

12) Zmena pobočky pre vozidlo podľa názvu pobočky

PUT https://a1.gpsguard.eu/api/v1/vehicle/change-branch-by-name

Zmení pobočku pre dané vozidlo. Prametry pre zmenu sa posielajú v tele requestu. Pobočky v danej skupine musí mať unikátnu názov.

Telo requestu:

{ 
  "VehicleCode": "CELIRASUME",
  "BranchName": "Pobocka 1"
}

13) Získať pobočky v skupine

GET https://a1.gpsguard.eu/api/v1/groups/{groupCode}/branches

napr.: https://a1.gpsguard.eu/api/v1/groups/sagu/branches - vracia zoznam pobočiek pre danú skupinu