API de streaming de coordenadas de objeto v2

La API de streaming de coordenadas de objeto v2 se usa para informal al usuario sobre cambios de objetos. Esta API particular funciona como un stream de información, usando tecnología SSE (eventos enviados por servidor). Al enviar una solicitud de API, al principio se muestra la última conocida coordenada para cada objeto, luego se mostrarán datos nuevos tan pronto como se ocurren cambios. No hay necesidad de enviar la solicitud de API de nuevo a menos que no hay conectividad de streaming.

Nota
Debido a que la API devuelve la última conocida coordenada, en los casos cuando el streaming de la API estaba activo y tuvo que reconectarse por alguna razón sin recibir coordenadas nuevas, el usuario recibirá la última conocida coordenada, duplicando el registro de coordenada. Hay que tener esto en cuenta, porque puede producir problemas en algunos sistemas.

La API de streaming de coordenadas de objeto v2 se puede iniciar para un objeto específico o para todos los objetos disponibles para el usuario.

Solicitud de datos en tiempo real para un objeto específico

Estructura de la solicitud:

GET /object-coordinates-stream?version=2&object_id=<…>&api_key=<…> 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=2&object_id=<…>&api_key=<…>”

Solicitud de datos en tiempo real para todos los objetos

Estructura de la respuesta:

GET /object-coordinates-stream?version=2&api_key=<…> 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=2&api_key=<…>”

data:
{
    "object_id":"ID0000",
    "datetime":"2019-02-11T02:00:00.000Z",
    "ignition_status":"OFF",
    "position":{
        "altitude" : 11,
        "direction" : 22,
        "latitude" : 33,
        "longitude" : 44,
        "satellites_count" : 16,
        "speed" : 77
    },
    "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
        }
    }
}

Si se ha introducido un parámetro incorrecto, el sistema responderá con un código de error. Los códigos de errores se describen en API. Los parámetros sin datos no se incluirán en la respuesta. Una lista completa de parámetros de respuesta está disponible al final de este capítulo.

Parámetros de la respuesta