El evento es la parte principal de esta API de ingesta de datos. En este elemento es donde se va a enviar a la plataforma la información del evento generado por cada uno de los dispositivos en tiempo real.
-
Method: POST
-
URL: {baseUrl}/v1/postincidence
-
Body:
{
"actionid": "1",
"detection_time": "2020-02-24T07:17:27Z",
"lon": -3.5 ,
"lat": 40.5,
"device_event_type": 1,
"device_event_type_value": 1,
"information_quality": 1
}
Atributo | Significado |
---|---|
idcompany | Identificador de la empresa |
actionid | Identificador único del evento anonimizando al dispositivo de origen,desde la activación a la desactivación |
token | Token generado para plataforma cliente durante la autenticación |
detection_time | Timestamp del instante en el que ocurre el evento, en formato ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
lon | Longitud geográfica del evento en coordenadas WGS84 |
Lat | Latitud geográfica del evento en coordenada WGS84 |
device_event_type | Tipo de evento con la plataforma 1 – Vehículo detenido |
device_event_type_value | Valor del tipo de evento. 1 – activación; 2 – activado; 3 - desactivación |
information_quality | Precisión GPS estimada en metros |
Obtención del id de empresa
-
Method: GET
-
URL: {baseUrl}/v1/idcompany
-
Body:
{
"info_code": 0,
"info_desc": "",
"data": [
{
"idEmpresa": 38
}
]
}
Requisitos
Con objeto de mantener la calidad de los mensajes se aplicarán los siguientes requisitos al contenido de los mensajes:
-
La posición geográfica debe estar contenida en el territorio español
-
Se establece a continuación el orden, cantidad y frecuencia de los mensajes:
- Eventos de tipo Activación, un único mensaje
- Eventos de tipo Activado, tantos mensajes cómo dure la actividad de la baliza con una frecuencia de 100 segundos entre mensajes.
- Eventos de tipo Desactivacion, un único mensaje.
-
La posición proporcionada por el GPS no debe tener un error mayor a 5 metros
-
Se aceptaran eventos con una antigüedad máxima de 15 segundos con respecto a la hora UTC, y que no sea un dato a futuro. En caso de no cumplirse, se recibirá un: HTTP Status: 400 Bad Request Error code: 24 para evento futuro o HTTP Status: 400 Bad Request Error code: 30 para evento pasado.