API de historial de coordenadas de objeto

El propósito principal de la API de historial de coordenadas de objeto es mostrar los datos historiales (coordenadas) de un objeto. La API de historial de coordenadas de objeto tiene dos puntos finales, así que hay dos tipos de solicitudes. El primer tipo de solicitud es para un objeto y una fecha y hora específica. Solo se muestran datos grabados a una fecha y hora especificada.

Ejemplo de solicitud para una fecha y hora específica:

GET /objects/{object_id}/coordinates/{datetime}?version=1&api_key=<…>
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8

Este tipo de solicitud necesita tres parámetros (sin contar el API_key) para que la solicitud de API trabaje:

Nota
Se recomienda utilizar el parámetro datetime desde el segundo punto final de API de historial de coordenadas de objeto, porque el parámetro de fecha y hora se específica por el segundo y el sistema no busca datos cerca de la fecha especificada.

Se muestra un ejemplo de respuesta a continuación, cuando todos los parámetros fueron incluidos y el API_key es válido:

{
    "object_id" : "abc123",
    "datetime" : "2017-04-13T06:58:48.090Z",
    "ignition_status" : "UNKNOWN",
    "position" : {
        "altitude" : 0,
        "direction" : 0,
        "latitude" : 0,
        "longitude" : 0,
        "hdop": 0,
        "satellites_count" : 0,
        "speed" : 0
    },
    "device_inputs" : {
        "digital_input_1" : true,
        "digital_input_2" : true,
        "digital_input_3" : true,
        "digital_input_4" : true,
        "power_supply_voltage" : 0,
        "ibutton" : "xxxxxxxxxx",
        "first_driver_id" : "xxxxxxxxxx",
        "second_driver_id" : "xxxxxxxxxx",
         "temperature_sensor_0": 0,
         "temperature_sensor_1": 0,
         "temperature_sensor_2": 0,
         "temperature_sensor_3": 0,
         "temperature_sensor_0_id": "xxxxxxxxxx"
    },
    "calculated_inputs":{
        "mileage" : 0
    }
}

Si se ha introducido un parámetro o API_key incorrecto, el sistema responderá con un código de error. Los códigos de errores se describen en API. Los parámetros se describen al final de este capítulo.

El segundo punto final de la API de historial muestra un array de datos historiales para un periódo definido, que se puede usar al enviar el primer tipo de solicitud de API.

Ejemplo de solicitud para un periódo específico:

GET /objects/{object_id}/coordinates?version=1{&from_datetime,to_datetime,continuation_token,limit}&api_key=<…>
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8

Este tipo de solicitud necesita tres parámetros (sin contar el API_key) para que la solicitud de API trabaje:

Los parámetros opcionales que no son obligatorios, pero pueden ser incluidos en la solicitud:

Ejemplo de respuesta:

{
  "continuation_token": "2017-04-13T06:58:48.121Z",
  "items": [
    {
     "object_id" : "abc123",
     "datetime" : "2017-04-13T06:58:48.090Z",
     "ignition_status" : "UNKNOWN",
     "position" : {
         "altitude" : 0,
         "direction" : 0,
         "latitude" : 0,
         "longitude" : 0,
         "hdop": 0,
         "satellites_count" : 0,
         "speed" : 0
     },
     "device_inputs" : {
         "digital_input_1" : true,
         "digital_input_2" : true,
         "digital_input_3" : true,
         "digital_input_4" : true,
         "power_supply_voltage" : 0,
         "ibutton" : "xxxxxxxxxx",
         "first_driver_id" : "xxxxxxxxxx",
         "second_driver_id" : "xxxxxxxxxx",
         "temperature_sensor_0": 0,
         "temperature_sensor_1": 0,
         "temperature_sensor_2": 0,
         "temperature_sensor_3": 0,
         "temperature_sensor_0_id": "xxxxxxxxxx"
     },
     "calculated_inputs":{
         "mileage" : 0
     }
    }
  ]
}

Todos los parámetros de respuesta que se puede recibir:

Se puede ver los puntos finales de API, los parámetros de solicitudes y las respuestas en “Swagger” haciendo clic en este enlace: https://api.fm-track.com