Web Service Paquetes

A continuación se explica brevemente la interfaz del Servicio Web para el envío o retransmisión de Paquetes generados por los dispositivos reportando en la plataforma de Monitoreo, a sus clientes o empresas externas autorizadas.

Tecnología de integración

Para poder integrar el envío de Paquetes, 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 ofrecemos se encuentra desarrollada bajo los estándares de RESTful según se describe en el presente documento.

Instrucciones de uso

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

08380160-416A-4793-AF38-23C37510D7D8.jpeg

Con el botón "Configurar Acceso" (icono anaranjado) abriremos la interfaz para realizar las configuraciones de envío:

4C998140-8BD9-488C-A3DA-FB693B74369A.jpeg

Se abrirá una ventana y debemos de elegir qué tipo de transmisión se va a ocupar para el envío de datos, TCP/UDP o API REST:

CBE1587A-55C8-4CB3-8E64-BF51690E0730.jpeg

Configurar Recurso

Podemos seleccionar dos tipos de recursos 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.

6B8B353E-6F1B-48B1-A8E8-E934264878E7.jpeg

 

Acceso por TCP/UDP:

Deberá proporcionar los siguientes parámetros.

  • Ip
  • Puerto
  • Protocolo: Debe especificar si usará TCP o UDP.

A4C51FC6-DFE6-4EA3-B413-D430FF0AE7EB.jpeg

Asignación de clientes y sus activos para el reenvío de paquetes al recurso previamente configurado:

1AFB41FE-DD5A-415D-9CC2-4ECFDA4D93CC.jpeg

Descripción del reenvío

Los equipos GPS del distribuidor/cliente reportan a la plataforma, se almacenan sus paquetes crudos en la base de datos (BD), el Web Service Paquetes se encarga de obtener la información de los paquetes crudos de los equipos y la reenvía a la URL o IP que se haya configurado previamente, en cuanto se obtenga un paquete este es inmediatamente reenviado.

La descripción general se puede representar con el siguiente diagrama:

image-1672845315237.png

 

Estructura del Web Service

Se ha creado una estructura que utiliza JSON como entrega, dependiendo la configuración TCP/UDP o API REST.

Identificador

Nombre

Tipo

Observaciones

device

Equipo

String

345456577489456

package

Paquete

String

2525A47121111JD124552525

date

Fecha

String

Y-m-d GMT dispositivo

time

Hora

String

H:i:s GMT dispositivo

asset

Nombre del activo

String

AA123

plate

Placa

String

SPP433

 

Ejemplo del envío:

{

       "device":"345456577489456",
       "package":"2525A47121111JD124552525",
       "date":"2024-09-11",
       "time":11:48:02",
       "asset":"AA123",
       "plate":"SPP433"

}

Visualización del log para el envío de paquetes:

8AF43C11-D041-44AF-AE65-7F43E4B51817.jpeg