Webservice de reenvío genérico

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.

 

Intrucciones de uso

Para poder utilizar el Servicio Web, cada distribuidor deberá ingresar a su Partners e ingresar a la opción "Webservice", ahí se encuentra listado "Generic Web Service":

image-1672951259412.png

Con el botón "Asignar activos" se seleccionan los clientes y las unidades que van a retransmitir al Servicio Web Genérico.

image-1672951397959.png

Una vez que seleccionamos el cliente, con el botón "Credenciales", se puede ingresar las credenciales de seguridad, en caso de que sea necesario, y el hostname, donde podemos indicar la URL a donde se enviará la información.

 

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:

image-1672845315237.png

 

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.

 

Identificador

Nombre

Tipo

Observaciones

deviceImei

Equipo

String

4176845511245678

dateTimeUtc

Fecha Hora

String

Y-m-d H:i:s GMT 0 o UTC

dateTimeLocal

Fecha Hora reporte

String

Y-m-d H:i:s 

latitude

Latitud

Double

-14.464430

longitude

Longitud

Double

-75.405083

speed

Velocidad (Km)

Double

19.0

direction

Orientación

Int

285

ignition

Ignición

Int

1 = Encendido / ON, 

0 = Apagado / OFF



Ejemplo del envío:

{

“deviceImei”:”4176845511245678”,

“dateTimeUtc”:”2021-08-21 18:21:22”,

“dateTimeLocal”:”2021-08-21 18:23:25”,

“latitude”:-14.464430,

“longitude”:-75.405083,

“speed”:19.0,

“direction”:285,

“ignition”:1

}