Web Service de Reenvío Genérico (Nueva Versión)
A continuación se explica brevemente la interfaz del Servicio Web Genérico de la plataforma de Monitoreo, para sus clientes o empresas externas autorizadas.
Tecnología de integración
Para la integración del Servicio Web de la plataforma de Monitoreo, se ha diseñado una arquitectura abierta, segura y compatible con las tecnologías más utilizadas en la industria actualmente, es por ello que la interfaz que ofrecemos se encuentra desarrollada bajo los estándares de RESTful Web Services según se describe en el presente documento.
Instrucciones de uso
Para utilizar la nueva versión del Servicio Web, cada distribuidor deberá ingresar a su Partners e ingresar a la opción "Webservice", ahí se encuentra listado "Generic Web Service":
Con el botón "Configurar Acceso" (icono anaranjado) abriremos la interfaz para configurar las credenciales:
Se abrirá una ventana con las siguientes pestañas:
- Credenciales
- Ubicación
- Alertas
- Eventos
- Paquetes
Configurar credenciales
Con la pestaña credenciales podemos seleccionar dos tipos de recurso para asignar las recursos de seguridad para el envío de datos.
- API REST
- TCP/UDP
Acceso por API REST:
Para configurar el acceso por API REST debemos ingresar la url del Host, donde podemos indicar la URL hacia donde se enviará la información.
Acceso por TCP/UDP:
Deberá proporcionar los siguientes parámetros.
- Ip
- Puerto
- Protocolo: Debe especificar si usará TCP o UDP.
Configurar Ubicación
En esta pestaña podrá seleccionar la información que desea enviar al Web Service, deberá establecer la URL a la que desea enviar la información deseada.
En caso de necesitarlo, podrá definir un alias para los parámetros que necesitará, así como establecer el tipo especifico de dato (texto, entero, flotante, etc...)
Los valores que puede configurar en la nueva versión del web service genérico se muestran a continuación en la siguiente tabla:
| URL | idconductor | gmt | tiempo | fecha | hora |
| latitud | longitud | timestamp | idtipo_dato_gps | velocidad | dirección |
| señal | satélites | input | odómetro | bateria_gps | bateria_veh |
| ignicion | buffered | equipo_gps | imei | id_vehiculo | vehiculo |
| placa | num_economico | horometro | odometro_vehiculo | notas | cliente |
| idcliente | rfc | distribuidor |
Configurar Alertas
En la nueva versión del Web Service es posible seleccionar los tipos de alertas y la información que desee enviar. Es posible editar el nombre y el tipo de dato de cada una de las alertas para tener un mejor control de la información enviada.
Para hacer uso de este servicio debe habilitarlo mediante la opción "¿Enviar datos de alertas emitidas?", posteriormente ingrese la URL de su Web Service y seleccione los tipos de alerta deseados.
Los valores que puede configurar se muestran a continuación en la siguiente tabla:
| equipo | fecha | hora | descripcion | latitud |
| longitud | domicilio | statusalerta | tipoalerta | idtipoalerta |
Configurar Eventos
En la nueva versión del Web Service es posible seleccionar los tipos de evento y la información que desee enviar. Es posible editar el nombre y el tipo de dato de cada una de las alertas para tener un mejor control de la información enviada.
Para hacer uso de este servicio debe habilitarlo mediante la opción "¿Enviar reportes de eventos?", posteriormente ingrese la URL de su Web Service y seleccione los tipos de alerta deseados.
Los valores que puede configurar se muestran a continuación en la siguiente tabla:
| idconductor | gmt | tiempo | fecha |
| hora | latitud | longitud | timestamp |
| idtipo_dato_gps | velocidad | dirección | señal |
| satelites | inputs | odometro | bateria_gps |
| bateria_veh | ignicion | buffered | equipogps |
| imei | idvehiculo | vehiculo | placa |
| num_economico | horometro | odometro_vehiculo | notas |
| cliente | idcliente | rfc | distribuidor |
Configurar Paquetes
Los valores que puede configurar se muestran a continuación en la siguiente tabla:
| idconductor | gmt | tiempo | fecha |
| hora | latitud | longitud | timestamp |
| idtipo_dato_gps | velocidad | direccion | señal |
| satélites | inputs | odometro | bateria_gps |
| bateria_veh | ignicion | buffered | equipogps |
| imei | idvehiculo | vehiculo | placa |
| num_economico | horometro | odometro_vehiculo | notas |
| cliente | idcliente | rfc | distribuidor |
Descripción del reenvío
Los equipos GPS del distribuidor/cliente reportan a la plataforma, se almacena la información en la base de datos (BD), el WebService Genérico se encarga de leer la información de los equipos y la reenvía a la URL que el cliente configure en la plataforma, en cuanto llegue un reporte este es inmediatamente reenviado.
La descripción general se puede representar con el siguiente diagrama:
Protocolo del WebService
Se ha creado una estructura de forma API RESTful que utiliza JSON como entrega mediante método POST, que se encarga de estar reenviando la información de los equipos GPS, que tenemos disponible en la plataforma a la URL que el cliente configure.
URL : La que el cliente configure.
Método : POST
Usuario: El que el cliente configure.
Contraseña: La que el cliente configure.
Ejemplo del envío:
{
"device":"111111111111111",
"latitude":"4.608071",
"longitude":"-74.175262",
"date":"2024-09-11",
"time":"11:48:02",
"timestamp":"20240911114802",
"speed":9,
"course":236,
"ignition":1,
"satellites":10,
"idevent":1,
"event":"Movimiento",
"signal":8,
"inputs":"0",
"isbuffer":0,
"odometer":345943.64845408,
"address":"Cl. 12 Sur #78m-333, México, México",
"asset":"632",
"plate":"XXX111",
"idclient":55524,
"client":"Cliente Example",
"idgroup":6943,
"group":"GRUPO 1",
"iddriver":0,
"driver":"",
"sensors":{
"82":{
"Bateria_gps":{
"name":"Bateria_gps",
"value":"",
"datetime":"2024-09-11 11:48:02",
"percentage":100
}
}
}
}