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/events
-
Body:
{ "actionId": "CLI_235", "beaconId": "cff92179-dc0a-47da-bd9e-5e9c5b14d251", "beaconTypeId": 2, "timestamp": "2021-03-15T13:34:00.000Z", "lonStart": -3.45368, "latStart": -3.45368, "lonEnd": 40.36586, "latEnd": 40.36586, "hdop": 1, "deviceTypeId": 1, "speed": 120, "eventTypeId": 2 }
* = Campo requerido
-
actionId * (texto): Identificador único del evento
-
beaconId * (texto): identificador único de la baliza (por ejemplo, la MAC)
-
beaconTypeId * (número entero): identificador del tipo de baliza. Posibles valores en /beaconTypes. 1 = Individual, 2 = Group
-
timestamp * (fecha UTC): fecha y hora en formato UTC del momento en el que el evento se ha generado. Es necesario que sea de un máximo de 15 segundos de antigüedad con respecto a la hora UTC. La fecha debe finalizar con el caracter 'Z' que marca que está en UTC
-
lonStart * (número decimal): longitud de coordenadas de tipo WGS 84 donde se ha generado el evento
-
latStart * (número decimal): latitud de coordenadas de tipo WGS 84 donde se ha generado el evento
-
lonEnd (número decimal): longitud de coordenadas de tipo WGS 84 donde finaliza el evento
-
latEnd (número decimal): latitud de coordenadas de tipo WGS 84 donde finaliza el evento
-
hdop * (número entero): valor DOP para determinar la calidad de la información del GPS. Más información aquí
-
deviceTypeId * (número entero): identificador del tipo de dispositivo desde el que se envía la información. Posibles valores en /deviceTypes. 1 = Baliza, 2 = App
-
speed * (número decimal): velocidad en kilómetros por hora a la que se encuentra el elemento en el momento que envía el evento
-
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
-
Dada la criticidad de la posición de estos dispositivos al estar ligados a personas en bicicleta, se establece una frecuencia de envío de mensajes máxima de un mensaje cada 15 segundos
-
La posición proporcionada por el GPS no debe tener un error mayor a 5 metros
-
Se requiere una antigüedad máxima de 15 segundos con respecto a la hora UTC, y que no sean eventos a con timestamp futuro.
-
Si el beaconTypeId es de tipo 2 = Group, los campos lonEnd y latEnd son requeridos
-
Se establece a continuación el orden y cantidad de los mensajes:
- Eventos de tipo Activado, tantos mensajes como dure la actividad.
- Eventos de tipo Apagado, un único mensaje.