Objektų koordinačių pateikimo API v3

Pastaba
Šis API nėra įtrauktas jokiame plane. Susisiekite su savo pardavimų vadybininku norėdami įgalinti šį API.

Objektų koordinačių pateikimo API v3 yra skirtas informuoti vartotoją apie objektų pokyčius. Ši API sąsaja veikia kaip informacijos srautas, naudojantis SSE (server sent events) technologiją. Kai vartotojas nusiunčia API užklausą, pirmiausia rodomos kiekvieno objekto vėliausios žinomos koordinatės, toliau vartotojui bus pateikiami nauji duomenys, vos tik įvyksta pokytis. Pakartotinai nusiųsti API užklausos nebūtina, nebent nutrūksta srauto ryšys.

Pastaba
Srauto ryšys bus automatiškai nutrauktas po 4 valandų, jei nėra naujų įrašų.

Pastaba
API pirmiausia parodo vėliausiai žinomas koordinates, tais atvejais, kai API srautas buvo nepertraukiamas ir dėl kokios nors priežasties buvo pakartotinai prisijungta, vartotojas gaus vėliausias žinomas koordinates, kurios jau buvo vieną kartą gautos. Dėl to, atsiras koordinačių įrašo kopija. Reikėtų tai atsiminti, nes tai gali sukelti problemų įvairiose sistemose.

Objektų koordinačių pateikimo API srautą galima pradėti vienam konkrečiam objektui arba visiems vartotojui pasiekiamiems objektams.

Realaus laiko duomenų užklausa konkrečiam objektui

Užklausos struktūra:

GET /object-coordinates-stream?version=3&object_id=<…>&api_key=<…>&include_nearest_geozone=<…> HTTP/1.1
Host: api.fm-track.com
Content-Type: text/event-stream;charset=UTF-8

curl -N –http2 “https://api.fm-track.com/object-coordinates-stream?version=3&object_id=<…>&api_key=<…>”

Realaus laiko duomenų užklausa visiems objektams

Užklausos struktūra:

GET /object-coordinates-stream?version=3&api_key=<…>&include_geozones=<…>&include_nearest_geozone=<…> HTTP/1.1
Host: api.fm-track.com
Content-Type: text/event-stream;charset=UTF-8

curl -N –http2 “https://api.fm-track.com/object-coordinates-stream?version=3&api_key=<…>”

Atsakymo pavyzdys

data:
{
    "object_id":"abc123",
    "datetime":"2019-02-11T02:00:00.000Z",
    "ignition_status":"OFF",
    "position":{
        "altitude" : 0,
        "direction" : 0,
        "latitude" : 0,
        "longitude" : 0,
        "satellites_count" : 0,
        "speed" : 0
    },
    "address": {
        "country": "Poland",
        "country_code": "PL",
        "county": "Województwo dolnośląskie",
        "region": "",
        "locality": "",
        "street": "E67",
        "house_number": "",
        "zip": "55"
    },
    "inputs":{
        "other":{
            "virtual_gps_odometer":0.0000,
            "country_code_geonames":91
        },
        "device_inputs":{
            "virtual_odometer":5.00,
            "digital_input_4":false,
            "driver_1_state":"DRIVE",
            "input_trigger":0,
            "tco_first_driver_state":"DRIVE",
            "priority":"LOW",
            ....,
            "hdop":"0.0"
        },
        "calculated_inputs":{
            "din4_working_time":0.00,
            "custom_input_3":0.00,
            "custom_input_6":0.00,
            "temperature":0.00,
            "custom_input_1":0.00,
            ....,
            "custom_input_2":0.00,
            "mileage":5000.00
        }
    },
"geozone_ids":["fde96c01","9b32bd68","95dcd895"],
"nearest_geozone":{
    "id":"fde96c01",
    "distance":150
}
}

Jei parametras arba API raktas įvestas neteisingai, sistema pateiks klaidos kodą, visi klaidų kodai aprašyti API skyriuje. Parametrai, kuriems duomenys nėra pateikti, nėra įtraukiami į atsakymą. Parametrai aprašyti šio skyriaus pabaigoje.

Atsakymo parametrai