0% encontró este documento útil (0 votos)
12 vistas7 páginas

Apm Rest Api V6

El documento describe la versión 6.0 del servicio web Sys4Log REST API, que permite la recepción de datos de posición para empresas de monitoreo vehicular mediante un formato JSON. Se establecen parámetros obligatorios y consideraciones para el consumo del servicio, incluyendo la frecuencia de las peticiones y el formato de los datos. Además, se incluyen ejemplos de peticiones y respuestas exitosas y fallidas del servicio.

Cargado por

Dario Quiñónez
Derechos de autor
© All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
0% encontró este documento útil (0 votos)
12 vistas7 páginas

Apm Rest Api V6

El documento describe la versión 6.0 del servicio web Sys4Log REST API, que permite la recepción de datos de posición para empresas de monitoreo vehicular mediante un formato JSON. Se establecen parámetros obligatorios y consideraciones para el consumo del servicio, incluyendo la frecuencia de las peticiones y el formato de los datos. Además, se incluyen ejemplos de peticiones y respuestas exitosas y fallidas del servicio.

Cargado por

Dario Quiñónez
Derechos de autor
© All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd

REST API

Definición de Servicio Web

versión 6.0

2025
SYS4LOGRESTAPI
Versión: 6.0
Actualizadoa: 22/08/2025

ALCANCE DEL DOCUMENTO


Diseño de estructura de recepción de datos de posición para distintas EMV (Empresas de Monitoreo
Vehicular).

CONTROL DE VERSIONES
VERSION FECHA
1.0 01/05/2020
2.0 27/05/2021
3.0 25/08/2022
4.0 14/05/2024
5.0 30/12/2024
6.0 22/08/2025

La presente versión sustituye completamente a todas las precedentes, de manera que este es el
único documento válido.
SYS4LOGRESTAPI
Versión: 6.0
Actualizadoa: 22/08/2025

DESCRIPCION DEL SERVICIO WEB


El servicio Web Sys4Log REST API está construido bajo la arquitectura REST. Para consumirlo se deberá
contar con:
- Dirección URL de consumo
- Trama de datos en formato JSON

CONSIDERACIONES DEL SERVICIO WEB


1. La configuración del periodo de consumo del servicio web debe ser de 60 segundos como mínimo
y 05 minutos como máximo, bajo cualquier estado de la unidad, ya sea con motor encendido,
apagado, ralentí, y otros.

2. La trama JSON debe contener todos los datos obligatorios.

3. Se podrán enviar 100 tramas como máximo por cada consumo de WS.

4. El consumo de dicho servicio web se realizará mediante una petición HTTP en el método POST

CONSUMO DEL SERVICIO WEB


La URL y el TOKEN de acceso serán modificados una vez que el servicio esté publicado en producción.

Recurso InsertarPosicion

· ENDPOINT: [Link]
· Method: POST
· Content-Type: application/json
· Header: Authorization: Bearer {token proporcionado}
SYS4LOGRESTAPI
Versión: 6.0
Actualizadoa: 22/08/2025

PARAMETROS JSON
FORMATO /
# PARÁMETRO TIPO DESCRIPCIÓN REQ.
OBSERVACIONES

1 imei STRING Identificador del AVL SÍ 15 dígitos

2 vehicle STRING Identificador del Vehículo (placa) SÍ Texto

3 transport_vendor STRING Nombre de la compañía de transporte SÍ Texto


Fecha/Hora de la trama en formato YYYY-MM-
4 date DATETIME SÍ
UTC 0 DDTHH:MM:SS

5 latitude STRING Coordenada en formato decimal SÍ Ejemplo: -12.0464


Entre -56 y 12, rango dentro de
Sudamérica

6 longitude STRING Coordenada en formato decimal SÍ Ejemplo: -77.0428


Entre -81 y -34, rango dentro de
Sudamérica
Kilómetros por hora
7 speed INTEGER Velocidad SÍ
(Km/h)
Código del país (ejemplo: PE, CL, BO,
8 country STRING SÍ Texto
EC)

9 address STRING Dirección SÍ Texto

10 odometer FLOAT Kilometraje SÍ Kilómetros


Valor máximo 300000000

11 bearer STRING Grados de inclinación SÍ Ejemplo: 180 o 359

12 altitude STRING Altitud respecto al nivel del mar SÍ Ejem: 1000 m

Nombre de la entidad de transporte


13 sat STRING SÍ Texto
reguladora

Estado del motor (encendido o


14 ignition BOOLEAN SÍ true / false
apagado)

15 battery_level NUMBER Número entre 0 y 100 SÍ Ejemplo: 85

Ejemplo: truck, trailer,


16 type STRING Tipo de vehículo SÍ
car, etc
SYS4LOGRESTAPI
Versión: 6.0
Actualizadoa: 22/08/2025

EJEMPLO DE PETICIÓN – 01 TRAMA

[
{
"imei":"864526381720",
"vehicle": "ABC123",
"transport_vendor":"EMPRESADETRANSPORTES",
"date":"2020-05-30T13:03:20",
"latitude": “-12.057074”,
"longitude": “-77.114773”,
"speed": 80,
"altitude":”440 m”,
"country": "PE",
"address":"Av.Lima123,JesusMaria",
"odometer": 12345,
"bearer": “210”,
"sat":"ENTIDADREGULADORA",
"ignition": true,
“battery_level”: 80,
“type”: “truck”
}
]

EJEMPLO DE PETICIÓN – VARIAS TRAMAS

[
{
"imei": "864526381720",
"vehicle": "ABC123",
"transport_vendor":"EMPRESADE TRANSPORTES",
"date": "2020-05-30T13:03:20",
"latitude": "-12.057074",
"longitude":"-77.114773",
"speed": 80,
"altitude": "440 m",
"country": "PE",
"address": "Av. Lima 123, Jesus Maria",
"odometer": 12345,
"bearer": "210",
"sat": "ENTIDAD REGULADORA",
"ignition": true,
“batery_level”: 25,
“type”: “truck”
},
{
"imei": "864526381740",
"vehicle": "ABC124",
"transport_vendor": "EMPRESADETRANSPORTES",
"date": "2020-05-30T13:03:20",
"latitude": "-12.057074",
"longitude":"-77.114745",
"speed": 80,
"altitude": "1000 m",
"country": "PE",
SYS4LOGRESTAPI
Versión: 6.0
Actualizadoa: 22/08/2025

"address": "Av. Lima 123, Jesus Maria",


"odometer": 12345,
"bearer": "210",
"sat": "ENTIDAD REGULADORA",
"ignition": true,
“battery_level”: 47,
“type”: “car”
}
]
SYS4LOGRESTAPI
Versión: 6.0
Actualizadoa: 22/08/2025

RESPUESTA EXITOSA
{

"message": "1 tramas insertadas exitosamente.",

"data": {

"imeis":

[ "864526381720",

"864526381740"

},

"status": true

RESPUESTA FALLIDA
{

"message": "1 tramas insertadas exitosamente. 1 trama no enviada: 864526381740 ",

"data": {

"imeis":

[ "864526381720"

],

"error":

[ "864526381740"

},

"status": false

También podría gustarte