API leírás

Bevezetés

Az engedélyezési kérelem jóváhagyása a Navitel Küldő Rendszerhez a program beállításaiban generált API kulcs segítségével történik. Az API kulcs generálásához, menj a Beállítások menübe > API.

Járművek listájának letöltése

Mielőtt a járművekre vonatkozó információkat az API kulcs segítségével le tudnád tölteni, létre kell hoznod a járművek és azok azonosító jellemzőinek listáját. Ennek érdekében, csinálj (GET) kérelmet:

https://www.dispatch.navitel.ru/api/1.0/vehicles.xml?apikey=[val]&namefilter=

ahol az "apikey=[val]" tipikus név/érték paraméter. Ennek a paraméternek az "apikey" része egy név, míg a "[val]" az érték bevezetésének a helye. Illeszdbe az API kódot, amelyet a program beállítások menüjében kaptál a paraméter érték (value) részébe. A járműveklistájáravonatkozó kérelem hasonlóan néz ki, mint:

https://www.dispatch.navitel.ru/api/1.0/vehicles.xml?apikey=00000000000000000000000&namefilter=

Továbbá a szűrő név paramétere a jármű kérelem lista végén kell hogy szerepeljen

namefilter=[value]

ahol "[value]" – a szűrő értéke. Megjelölhetsz egy adott objektum nevet, amelyikről meg szeretnél szerezni információt, vagy üresen hagyhatod a mezőt, ha vissza szeretnéd állítani az összes objektum listáját, mint a fenti példában.

A járművek listájának kikérése után megkapod a választ XML formátumban, vagy JSON kódolásban.

<reply> <result type="array"> <v i="0"> <group_name>security_group</group_name> <tracker_id>GALILEOSKY:00000000000000000000000000000000</tracker_id> <tracker_type>GALILEOSKY</tracker_type> <vehicle_id>xxxxx-xxxx-xxxx-xxxxxxxxxxxx</vehicle_id> <vehicle_name>Subaru</vehicle_name> </v> <v i="1"> <group_name>security_group</group_name> <tracker_id>GRANIT:00000000000000000000000000000</tracker_id> <tracker_type>GRANIT04</tracker_type> <vehicle_id>xxxxx-xxxx-xxxx-xxxxxxxxxxxx</vehicle_id> <vehicle_name>cardabalet</vehicle_name> </v> </result> </reply>

A válasz tartalmazza az információt a járművekről, beleértve a csoportot/céget, a nyomkövető imei-t /id-t, nyomkövető típusát, jármű id-t és a jármű megnevezését. Felhasználhatod ezeket az adatokat később, azon járművek azonosításához, amelyekről Meghatározhatod a kérelmed eredményének előnyben részesített formátumát. Ehhez add hozzá a megfelelő kiterjesztést a "járművek" szó után. Lehetséges kiterjesztések: „.xml", vagy ".json" (ez a funkcionalitás elérhető akármelyik kérelem típusnál a küldő rendszerben).

Az eredmény ebben a példában XML formátumban lesz megadva

https://www.dispatch.navitel.ru/api/1.0/vehicles.xml

és ebben a példában, az eredmény JSON kódolásban lesz biztosítva

https://www.dispatch.navitel.ru/api/1.0/vehicles.json
Megfigyelésiinformációk letöltése

Egy átlagoskérelem a küldő rendszerbe lényegében egy olyan sor, amelyik alap URL-ből és kérelmi paraméterek készletéből áll. Az alap URL-nek mindig ilyennek kell lennie (kivéve, amikor a járművek listájának letöltésevan folyamatban):

https://www.dispatch.navitel.ru/api/1.0/vehicleinfo.xml?

A kérelmi paraméterek a név/érték párok sora, mindegyik pár "&" jellel van elkülönítve. Az alap URL-ben egyből a kérdőjel után kell elhelyezni. Mindegyik paraméternek a következő név/érték formája van:

field=[value]

ahol "[field]" a paraméter neve, és a "[value]" az érték paramétere. Több lehetséges név alkalmas a bevitelre: "id", "name", "imei", "time", "what", "apikey". A bevitel nagy-kis betű érzékeny.

A kérelemnek normálisan tartalmaznia kell olyan paramétereket, mint az alábbiak:

  1. Járműazonosítók készlete. Mindegyik jármű azonosítva van egy, a három lehetséges azonosító által: "id", "name", "imei". Az azonosítás lényegében ilyen típusú sor:

    id=[vehicle_static_id_0]

    ahol "[vehicle_static_id_0]" a jármű ID-je, amit a járművek listáját kikérve kaphatsz meg.

    Mivel az azonosításra csak a név/érték paraméterek szolgálnak, ezekből többet is használhatsz, hogy több járműről kapj információt. Hasonlóan a többi paraméterhez, az azonosítókat & jellel kell elválasztani.

    id=[vehicle_static_id_0]&id=[vehicle_static_id_0]

    Használhatsz különböző típusú azonosítókat akkor, amikor meghatározod a járművet a kérelemben. Például:

    id=[vehicle_static_id_0]&name=[vehicle_name]&imei=[vehilce_imei]&id=[vehicle_static_id_N]

    Abban az esetben, ha előfordul, hogy különböző azonosító adatokat adsz meg ugyanarról a járműről, ne aggódj, a jármű mindig csak egyszer kerül feltüntetésre.

  2. API kód:

    apikey=[val]

    ahol "[val]" az API kód, amelyiket a küldő rendszer beállításaiban kapsz meg.

  3. Szükséges paraméterek készlete, mindegyik paraméter az "&” jellel van elválasztva:

    field=[value]&field=[value]&field=[value]

    ahol "[field]" a paraméter neve és a "[value]" az érték paramétere. Használd a lent található táblázatokat, mint utasítást a paraméterek helyes neveihez és értékeihez.

Meghatározott időre vonatkozó T paraméterek

Most már tudod hogyan kell bevinni a járműazonosító és API kód paramétereket a kérelembe. Hátra van méga "what" paraméter, amelyik arra használandó, hogy kikérjük az információt a paraméter blokk értékében egy meghatározott mutatóról.

Amennyiben egy adott időben a jármű sebességére vonatkozó információt szeretnéd megszerezni, ezt a paramétert kell használnod

what=speed_kmh

a teljes kérelem a következőképpennéz ki:

https://www.dispatch.navitel.ru/api/1.0/vehicleinfo.xml?apikey=00000000000000000000000&name=NaviCar&what=speed_kmh

A fenti példában információ a jármű sebességéről az API hozzáférési kód segítségével kerüllekérdezésre, ahol a küldő rendszerhez való hozzáférés miatt került alkalmazásra. A jármű,mint "NaviCar" került azonosításra, az API kód pedig mint "00000000000000000000000". Hasonlóan, kérelmezheted az információt az alább felsorolt paraméterekkel is. Az összes paraméter név ebbena táblázat a "what"; az értéket a táblázat „Érték” oszlopából kell kiválasztani.

Paraméter leírása
Érték
Paraméter leírásagyújtás
Értékignition
Paraméter leírásaFöldrajzi szélesség, Földrajzi hosszúság
Értéklat_deg, lon_deg
Paraméter leírásasebesség
Értékspeed_kmh
Paraméter leírásamozgási irány
Értékdirection_deg
Paraméter leírásaműholdak mennyisége, hdop
Értéksatellite_count, hdop
Paraméter leírásamagasság
Értékaltitude_m
Paraméter leírásagsm paraméterek (mcc,mnc,lac etc)
Értékmcc, mnc, lac, cellid, jel_erő, időzítés_előre
Paraméter leírásakülső tápfeszültség
Értékkülső_táp_mv
Paraméter leírásabelső akkumulátor feszültség
Értékakkumulátor_táp_mv
Paraméter leírásaNyomkövető hőmérséklete
Értékhőmérséklet_c
Paraméter leírásagyorsulásmérő mérései (x, y, z)
Értékgyorsulás_x_ms2,
gyorsulás_y_ms2,
gyorsulás_z_ms2
Paraméter leírásariasztó nyomógomb
Értékriasztó_be
Paraméter leírásahűtő hőmérséklete
Értékhűtő_temp_c
Paraméter leírásamotor fordulatszáma
Értékmotor_rpm
Paraméter leírásaüzemanyagszint (%)
Értéküzemanyag_százalék
Paraméter leírásatávolság
Értéktávolság_km
Paraméter leírásaösszes elfogyasztott üzemanyag
Értékösszes_elfogyasztott_üzemanyag_l
Paraméter leírásaüzemanyagszint (CAN)
Értéküzemanyag_tartály_l
Paraméter leírásaMotor működési ideje (CAN)
Értékmórák
Paraméter leírásasebesség (CAN)
Értékcan_sebesség_kmh
Paraméter leírásaüzemanyagszint (számolt, konvertált stb.)
Értéküzemanyag_l
Paraméter leírásaanalóg inputok
Értékanalóg_input
Paraméter leírásadigitális inputok
Értékdigitális_input
Paraméter leírásacan input
Értékcan_input
Paraméter leírásafrekvencia input
Értékfrekvencia_hz
Paraméter leírásaimpulzus számlálók
Értékimpulzus_számláló_pcs
Paraméter leírásatengelyterhelés
Értéktengely_terhelés_kg
Paraméter leírásacan log verzió
Értékcan_log_verzió
Paraméter leírásamegkapott csomagolt fájl mérete bájtokban
Értékin_darab_méret
Paraméter leírásamegkapott csomagok számlálója
Értékin_csomag_számláló
Paraméter leírásaa szerver válasza bájtokban
Értékki_nagy_méret
Paraméter leírásaa szerver válaszok száma
Értékki_csomagszámláló
Paraméter leírásaa vezetékes input értékek listája
Értékegy_vezeték_input
Paraméter leírásaa szenzor input értékek listája
Értékszenzor_input
Paraméter leírásaanalóg input értékek listája
Értékfeszültség_mv
Idő meghatározás

Amikor egy paraméter sincs meghatározva a kérelemben, akkor a válasz az idő jelenlegi pillanatának megfelelő adatot fogja tartalmazni. A különböző pillanatok időben történő meghatározásához a kérelemben speciális időparaméter kerül felhasználásra:

time=[val]

ahol "[val]" a pillanat az ISO 8601 sztenderdnek megfelelően időben meghatározott (lásd: https://en.wikipedia.org/wiki/ISO_8601).
A bevitel nagy-kis betű érzékeny.

Ennek a sztenderdnek megfelelően, az idő formátuma a következő: "YYYY-MM-DDThh:mm:ss". Ezért az inputnak a következőnek kell lennie:

time=2015-07-12T12:00:00

ahol a dátum a következőképpen kerülfeltüntetésre: 2015 Július 12 és az idő 12:00:00.

Meghatározhatod még az időzónát az időparaméter értékében is, hozzáadva az időzóna nevét az érték vége után (példáúl, MSK, vagy "Asia/Novosibirsk").

time=2015-07-12T12:00:00MSK

Az UTC időzóna megjelöléséhez, egyszerűen adj hozzá "Z" jelet, a paraméter érték végén.

Ezek mellett az időzónát meg lehet határozni közvetlenül megjelölve az időt az UTC-hez viszonyítva.

time=2015-07-22T12:00:00+03:00
Idő intervallum meghatározása

Amennyiben meg szeretnéd határozni az időintervallumot, akkor jelölj meg 2 idő pillanatot, ahogyan bemutatásra került az az előző fejezetben és válaszd el őket tört vonallal.

time=[val1]/[val2]

ahol "[val1]" – az időintervallum eleje, és "[val2]" a vége.

Például:

time=2015-07-12T12:00:00/2015-07-15T15:52:01

Ez azt jelenti, hogy az időintervallum 2015 július 12, 12:00:00 kezdődik, és 2015 július 15, 15:52:01 végződik.

Lehetséges még időintervallum létrehozása "IsoTime/tartam" formátumban is, ahol az intervallum tartama mint, "PxxYxxMxxDTxxHxxMxxSkerülmeghatározásra (a P prefixet követi az intervallum tartalma, ami kis-nagy betű érzékeny). Ha be van állítva az időintervallum, akkor ennek az intervallumnak a legnagyobb értéke a paraméterek A csoportjába tartozik.

Az alábbi táblázat tartalmazzaa "what" paraméterek listáját, amelyek mindigidőintervallum paramétereivel együttkerülnek felhasználásra:

Paraméter leírása
Érték
Paraméter leírásamozgás időtartama
Értékmozgásidő
Paraméter leírásaállás időtartama
Értékállásidő
Paraméter leírásaállás adatok nélkül
Értékelveszett Jelidő
Paraméter leírásatávolság
ÉrtékmegtettKilóméterek
Paraméter leírásaüzemanyag fogyasztás literben
ÉrtékösszesÜzemanyagFogyasztás
Paraméter leírásaátlagos sebesség
ÉrtékavgMozgásiSebesség
Paraméter leírásamaximális sebesség
ÉrtékmaxSebesség
Paraméter leírásakiindulási pont
Értékindulási hely
Paraméter leírásaérkezési pont
Értékérkezés helye
Paraméter leírásavége/kezdő üzemanyag szint
ÉrtékvégsőÜzemanyagSzint, kezdőÜzemanyagSzint
Paraméter leírásaüzemanyag fogyasztás (literek) per /100km
ÉrtéküzemanyagPer100Km
Paraméter leírásaüzemanyag/fogyasztás számláló (esetek)
ÉrtéktankolásSzámláló, tankolásFogyasztásSzámláló
Paraméter leírásaüzemanyag/fogyasztás számláló (literek)
ÉrtékösszesTankolás, összesÜzemanyagFogyasztás