Manual API Imovit V1.01

STI SOLUTIONS S.A DE C.V.
Fecha 28/06/2019
API iMovit Versión: 1.01
IMOVIT API
Pag. 1/2
STI SOLUTIONS S.A DE C.V. Fecha 28/06/2019
1. Introducción
La documentación del API de IMOVIT explica su funcionamiento y detalla cada uno de los
métodos desarrollados.
Ejemplo de solicitud https://ci8dp85wa4.execute-api.us-east-1.amazonaws.com/imovit
2. Método: Login de usuario.
Petición Método Descripción Cabeceras
/access/login POST Validar usuario para inicio de sesión Content-Type
2.1 Parámetros.
Nombre Valor Descripción Tipo
keyUser Requerido Key de cliente string
user Requerido Usuario del cliente string
pass Requerido Contraseña del usuario string
Pag. 2/2
Respuesta Ejemplo de respuesta (json)
{
"codeResponse": 200,
200: Satisfactoria
"token": "token_usuario"
}
400: Error, revisar "codeResponse": 400,

datos de cliente "message": "La KEY no coincide con nuestros registros."
}
{
401: Error, revisar
datos de usuario "message": "Las credenciales no coinciden con nuestros
registros."
}
3. Método: Cierre de sesión (logout).
/access/logout POST Finalizar sesión de usuario Content-Type

accessToken
{
200: Satisfactoria
"message": "Sesión finalizada con éxito."
}
Pag. 3/2
{
400: Error, revisar
cabeceras enviadas "message": "Para finalizar sesión revisa los parámetros
enviados."
}
4. Método: Obtener versión de API.
/apiVersion GET Obtener versión actual de API Content-Type

accessToken
{
200: Satisfactoria
"message": "API versión: 1.0"
}

cabeceras enviadas "message": "Error al validar Token."
}
Nota: en caso de obtener otro código de respuesta, revisar los errores genéricos, que se
encuentra al final del documento.
Pag. 4/2
5. Método: Posición actual de dispositivo.
/positions/getPosition GET Retorna la posición actual del Content-Type

vehículo accessToken
5.1 Parámetros.
placa_vehiculo Requerido Placa del vehículo (eje. “361ZUE”) string
{
"code": 200,
"data": {
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 22:36:45",
"latitud": "19.43856",
200: Satisfactoria "longitud": "-99.20093",
"velocidad": "5",
"distancia": "26470166",
"horimetro": "0000077941",
"voltajeBateria": "4.1",
"cursoSobreTerreno": "233.13",
"satelites": "5",
Pag. 5/2
"voltajePrincipal": "14.30",
"fixGPS": null,
"radio": null,
"ignicion": "1"
}
}
404: Error en placa "codeResponse": 404,

del vehículo "message": "Error al validar vehículo"
}
Pag. 6/2
6. Método: Obtener posiciones por rango de fecha.
Petición /positions/getHistoricalPositionDates
Método Descripción Cabeceras
GET Retorna un listado de las posiciones y los eventos del Content-Type

vehículo en el rango de fechas especificadas. accessToken
6.1 Parámetros.
startDate Requerido Fecha de inicio (eje. “2019-01-27”) string
endDate Requerido Fecha final (eje. “2019-05-28”) string
"code": 200,
"data": {
"positions": [
{
200, Satisfactoria
"IDEquipo": 907510242,
"FechaUTC": "2019-05-27 05:05:40",
"latitud": "19.44225",
"longitud": "-99.20005",
Pag. 7/2
"velocidad": "0",
"distancia": "25744176",
"horimetro": "0000076810",
"satelites": "0",
"fixGPS": "0",
"radio": null,
"ignicion": "0"
},
{
"IDEquipo": 907510242,
"FechaUTC": "2019-05-27 06:05:40",
"latitud": "19.44225",
"longitud": "-99.20005",
"velocidad": "0",
"distancia": "25744176",
"horimetro": "0000076810",
………..
}, …….
]
"events": [
{
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 13:34:08",
"latitud": "19.4645",
"longitud": "-99.14536",
"velocidad": "52",
"distancia": "26455672",
Pag. 8/2
"horimetro": "0000077845",
"satelites": "11",
"fixGPS": "1",
"radio": null,
"ignicion": "1"
},
{
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 13:34:15",
"latitud": "19.4642",
"longitud": "-99.14638",
"velocidad": "65",
"distancia": "26455784",
"horimetro": "0000077845",
…….
}, …….
]
}

}
Pag. 9/2
7. Método: Obtener posiciones por rango de horas.
Petición /positions/getHistoricalPositionHours
GET Retorna un listado de las posiciones y los eventos del Content-Type

vehículo en el rango de horas y día especificados. accessToken
7.1 Parámetros.
day Requerido Día de consulta (eje. “2019-01-27”) string
hourStar Requerido Hora de inicio (eje. “05:00:00”) string
hourEnd Requerido Hora final (eje. “15:00:00”) string
"code": 200,
"data": {
"positions": [
{
200, Satisfactoria
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 10:04:16",
"latitud": "19.58494",
"longitud": "-99.00656",
Pag. 10/2
"velocidad": "0",
"distancia": "26421753",
"horimetro": "0000077767",
"satelites": "12",
"fixGPS": "1",
"radio": null,
"ignicion": "0"
},
{
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 11:04:16",
"latitud": "19.58493",
"longitud": "-99.0065",
"velocidad": "0",
"distancia": "26421753",
"horimetro": "0000077767",
………..
}, …….
]
"events": [
{
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 13:34:08",
"latitud": "19.4645",
"longitud": "-99.14536",
"velocidad": "52",
Pag. 11/2
"distancia": "26455672",
"horimetro": "0000077845",
"satelites": "11",
"fixGPS": "1",
"radio": null,
"ignicion": "1"
},
{
"IDEquipo": 907510242,
"FechaUTC": "2019-05-29 13:34:15",
"latitud": "19.4642",
"longitud": "-99.14638",
"velocidad": "65",
"distancia": "26455784",
"horimetro": "0000077845",
…….
}, …….
]
}

}
Pag. 12/2
8. Método: Obtener equipo más cercano.
Petición /positions/getClosestDevice
Devuelve el equipo más cercano en base a la latitud y

longitud proporcionados. Mediante el parámetro Content-Type
GET
“disp_in_vehicle” se especifica que el dispositivo más accessToken
cercano se encuentre en un vehículo o no.
Parámetros.
lat Requerido Latitud de referencia (eje. “19.073772”) string
long Requerido Longitud de referencia (eje. “-98.19196”) string
Si se desea que el dispositivo a buscar se

encuentre en un vehículo, el valor debe ser
disp_in_vehicle Opcional igual a 1. Si el parámetro se envía nulo o con int
un número diferente de 1, el método solo
retorna el dispositivo más cercano.
"code": 200,
"data": [{
200, Satisfactoria "IDEquipo": 4045350,

(disp_in_vehicle = 1) "Placa": "3DBA26",
"FechaUTC": "2018-10-05 17:07:25",
"latitud": "19.057925",
Pag. 13/2
"longitud": "-98.206906",
"velocidad": null,
"distancia": null,
"horimetro": null,
"voltajeBateria": null,
"cursoSobreTerreno": null,
"satelites": null,
"voltajePrincipal": null,
"fixGPS": null,
"radio": null,
"ignicion": null
}]
"code": 200,
"data": [{
"IDEquipo": 4802921,
"Placa": null,
"FechaUTC": "2019-05-31 15:23:37",
"latitud": "19.06964",
"longitud": "-98.18849",
200, Satisfactoria "velocidad": null,
(disp_in_vehicle = no
especificado) "distancia": "0",
"horimetro": null,
"voltajeBateria": null,
"cursoSobreTerreno": null,
"satelites": null,
"voltajePrincipal": null,
"fixGPS": null,
"radio": null,
Pag. 14/2
"ignicion": null
}]
Pag. 15/2
9. Método: Obtener eventos de los vehículos del usuario.
Petición /cars/getVehiclesEvents
GET Retorna un listado de los vehículos y los últimos 10 Content-Type

eventos y los últimos 10 eventos tratados asociados a accessToken
cada uno.
9.1 Parámetros.
user Requerido Nombre del usuario string
{
"data": [
{
"Vehiculo": "310E",
"ID_Dispositivo": 7347501,
200, Satisfactoria
"Marca": null,
"Modelo": null,
"Color": "#F9F81F",
"Año": "2000",
"Chasis": "",
"Renave": "",
Pag. 16/2
"Comentario": "NULL",
"Etiqueta": null,
"Eventos": [
[
{
"Mensaje": "Ignición off",
"Latitud": "19.48274",
"Longitud": "-98.83487",
"Fecha": "2019-06-28 17:05:40",
"Dirección": ""
},
{
"Mensaje": "Ignición on",
"Latitud": "19.48623",
"Longitud": "-98.84676",
"Fecha": "2019-06-28 16:44:07",
"Dirección": ""
},
{
"Latitud": "19.48623",
"Longitud": "-98.84677",
"Fecha": "2019-06-28 16:31:56",
"Dirección": ""
},
{
"Latitud": "19.48753",
"Longitud": "-98.83874",
Pag. 17/2
"Fecha": "2019-06-28 15:36:58",

"Dirección": ""
},
{
"Latitud": "19.48753",
"Longitud": "-98.83874",
"Fecha": "2019-06-28 15:36:50",
"Dirección": ""
},
{
"Latitud": "19.48748",
"Longitud": "-98.83866",
"Fecha": "2019-06-28 15:35:08",
"Dirección": ""
},
{
"Latitud": "19.48747",
"Longitud": "-98.83869",
"Fecha": "2019-06-28 15:21:27",
"Dirección": ""
},
{
"Latitud": "19.48753",
"Longitud": "-98.83877",
"Fecha": "2019-06-28 15:13:18",
Pag. 18/2
"Dirección": ""
},
{
"Latitud": "19.48753",
"Longitud": "-98.83877",
"Fecha": "2019-06-28 15:07:13",
"Dirección": ""
},
{
"Latitud": "19.48753",
"Longitud": "-98.83877",
"Fecha": "2019-06-28 15:02:02",
"Dirección": ""
}
],
[
{
"Latitud": "19.4863",
"Longitud": "-98.84691",
"Fecha": "2019-06-27 16:16:12",
"Dirección": ""
},
{
"Latitud": "19.48628",
"Longitud": "-98.84687",
"Fecha": "2019-06-27 16:14:29",
"Dirección": ""
Pag. 19/2
},
{
"Latitud": "19.48628",
"Longitud": "-98.84687",
"Fecha": "2019-06-27 16:12:58",
"Dirección": ""
},
{
"Latitud": "19.4863",
"Longitud": "-98.84696",
"Fecha": "2019-06-27 15:44:20",
"Dirección": ""
},
{
"Latitud": "19.48629",
"Longitud": "-98.84696",
"Fecha": "2019-06-27 15:34:10",
"Dirección": ""
},
{
"Latitud": "19.48654",
"Longitud": "-98.84789",
"Fecha": "2019-06-27 14:57:24",
"Dirección": ""
},
{
"Latitud": "19.48654",
"Longitud": "-98.84789",
"Fecha": "2019-06-27 14:57:10",
Pag. 20/2
"Dirección": ""
},
{
"Latitud": "19.48499",
"Longitud": "-98.84209",
"Fecha": "2019-06-27 14:38:48",
"Dirección": ""
},
{
"Latitud": "19.48499",
"Longitud": "-98.84209",
"Fecha": "2019-06-27 14:36:29",
"Dirección": ""
},
{
"Latitud": "19.48478",
"Longitud": "-98.84117",
"Fecha": "2019-06-27 14:27:58",
"Dirección": ""
}
]
]
}
401: Error en campo "codeResponse": 401,

USER "message": "Error al validar usuario"
}
Pag. 21/2
10. Mensajes de Error Genéricos
{
401: Error, revisar las
"message": "No autorizado, favor de revisar
cabeceras de la petición
cabeceras de solicitud"
}
401: Error, token no "codeResponse": 401,

enviado "message": "Error al validar Token"
}

parámetros enviados "message": "Parámetros de solicitud no válidos"
}
401: Error, tiempo de sesión "codeResponse": 401,

finalizado, se debe iniciar "message": "El tiempo de sesión ha caducado, para
sesión de nuevo continuar debes iniciar sesión."
}
{
404: Error por alguna falla "codeResponse": 404,
ajena al sistema (ejemplo:
pérdida de conexión) "message": "Algo ha ido mal, intenta más tarde."
}
Pag. 22/2
11. Control de Revisiones.
Versión Comentarios Autor

1.00 Versión inicial del documento J. Martínez
1.01 Se agrega Método de sección 9 J. Martínez / R. Avilés
Pag. 23/2

Manual API Imovit V1.01

Cargado por

Información del documento

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Manual API Imovit V1.01

Cargado por

Copyright:

Formatos disponibles

STI SOLUTIONS S.A DE C.V.

API iMovit Versión: 1.01

API iMovit Versión: 1.01

Ejemplo de solicitud https://ci8dp85wa4.execute-api.us-east-1.amazonaws.com/imovit

2. Método: Login de usuario.

Petición Método Descripción Cabeceras

/access/login POST Validar usuario para inicio de sesión Content-Type

Nombre Valor Descripción Tipo

keyUser Requerido Key de cliente string

user Requerido Usuario del cliente string

pass Requerido Contraseña del usuario string

API iMovit Versión: 1.01

Respuesta Ejemplo de respuesta (json)

400: Error, revisar "codeResponse": 400,

3. Método: Cierre de sesión (logout).

Petición Método Descripción Cabeceras

/access/logout POST Finalizar sesión de usuario Content-Type

Respuesta Ejemplo de respuesta (json)

API iMovit Versión: 1.01

4. Método: Obtener versión de API.

Petición Método Descripción Cabeceras

/apiVersion GET Obtener versión actual de API Content-Type

Respuesta Ejemplo de respuesta (json)

400: Error, revisar "codeResponse": 400,

API iMovit Versión: 1.01

5. Método: Posición actual de dispositivo.

Petición Método Descripción Cabeceras

/positions/getPosition GET Retorna la posición actual del Content-Type

Nombre Valor Descripción Tipo

placa_vehiculo Requerido Placa del vehículo (eje. “361ZUE”) string

Respuesta Ejemplo de respuesta (json)

API iMovit Versión: 1.01

404: Error en placa "codeResponse": 404,

API iMovit Versión: 1.01

6. Método: Obtener posiciones por rango de fecha.

Método Descripción Cabeceras

GET Retorna un listado de las posiciones y los eventos del Content-Type

Nombre Valor Descripción Tipo

placa_vehiculo Requerido Placa del vehículo (eje. “361ZUE”) string

startDate Requerido Fecha de inicio (eje. “2019-01-27”) string

endDate Requerido Fecha final (eje. “2019-05-28”) string

Respuesta Ejemplo de respuesta (json)

API iMovit Versión: 1.01

API iMovit Versión: 1.01

404: Error en placa "codeResponse": 404,

API iMovit Versión: 1.01

7. Método: Obtener posiciones por rango de horas.

Método Descripción Cabeceras

GET Retorna un listado de las posiciones y los eventos del Content-Type

Nombre Valor Descripción Tipo

placa_vehiculo Requerido Placa del vehículo (eje. “361ZUE”) string

day Requerido Día de consulta (eje. “2019-01-27”) string

hourStar Requerido Hora de inicio (eje. “05:00:00”) string

hourEnd Requerido Hora final (eje. “15:00:00”) string

Respuesta Ejemplo de respuesta (json)

API iMovit Versión: 1.01

API iMovit Versión: 1.01

404: Error en placa "codeResponse": 404,

API iMovit Versión: 1.01

8. Método: Obtener equipo más cercano.

Método Descripción Cabeceras

Devuelve el equipo más cercano en base a la latitud y

Nombre Valor Descripción Tipo