... | ... | @@ -11,7 +11,7 @@ siguiente URL (URL base): |
|
|
|
|
|
## Publicación
|
|
|
|
|
|
Para **publicar** información se dispone una API REST:
|
|
|
Este caso de uso dispone de una API REST para la publicación (envío) de los datos por parte de las empresas que así lo deseen. En los siguientes apartados se pueden encontrar los detalles de esta:
|
|
|
|
|
|
- Los detalles generales para realizar una petición:
|
|
|
|
... | ... | @@ -27,18 +27,53 @@ Para **publicar** información se dispone una API REST: |
|
|
|
|
|
## Suscripción
|
|
|
|
|
|
La parte de suscripción al servicio del caso de uso 5 se hará mediante el protocolo MQTT.
|
|
|
Este caso de uso también dispone de un servicio de suscripción (recepción) de datos por parte de las empresas que así lo deseen mediante el protocolo MQTT. A continuación se pueden encontrar los detalles de esta:
|
|
|
|
|
|
**MQTT (MQ Telemetry Transport)** es un protocolo de mensajería que se usa como un método simple y liviano para transferir datos hacia/desde dispositivos de baja potencia.
|
|
|
|
|
|
El protocolo admite un único patrón de mensajería, el patrón **Publicar-Suscribir**: cada mensaje es publicado en un tópico al que se debe suscribir para recibir la información.
|
|
|
El protocolo admite un único patrón de mensajería, el patrón **Publicar-Suscribir** y cada mensaje es publicado en un tópico al que se debe suscribir para recibir la información.
|
|
|
|
|
|
La suscripción al servicio de este caso de uso deberá ser mediante el tópico:
|
|
|
La suscripción al servicio de este caso de uso deberá ser al tópico:
|
|
|
|
|
|
> usecase5/events
|
|
|
|
|
|
Ver más información y un ejemplo de conexión [aquí](https://gitlab.cmobility30.es/dgt3.0_esp/general/-/wikis/MQTT).
|
|
|
En el tópico se publican los eventos en formato JSON. Aquí se puede ver un ejemplo:
|
|
|
|
|
|
#### Información Disponible:
|
|
|
```json
|
|
|
{
|
|
|
"beaconTypeId": 1,
|
|
|
"timestamp": "2021-06-02T13:34:56.747Z",
|
|
|
"lon": -4.304818,
|
|
|
"lat": 41.312456,
|
|
|
"eventTypeId": 1,
|
|
|
"speed": 85,
|
|
|
"provinceId": 40,
|
|
|
"road": "A-601",
|
|
|
"pk": 64.73,
|
|
|
"direction": "UP"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
La información que se está publicando en el entorno de desarrollo es una simulación con información no real que va cambiando a lo largo del día, de forma que se pueda probar la interface de consumo. |
|
|
- beaconTypeId (número entero): identificador del tipo de baliza. 1 = Start, 2 = End, 3 = Intermediate, 4 = Perimeter
|
|
|
|
|
|
- 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 30 segundos de antiguedad con respecto a la hora UTC. La fecha debe finalizar con el caracter 'Z' que marca que está en UTC
|
|
|
|
|
|
- lon (número decimal): longitud de coordenadas de tipo WGS 84 donde se ha generado el evento
|
|
|
|
|
|
- lat (número decimal): latitud de coordenadas de tipo WGS 84 donde se ha generado el evento
|
|
|
|
|
|
- eventTypeId (número entero): identificador del tipo de evento. 1 = Start, 2 = End
|
|
|
|
|
|
- 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
|
|
|
|
|
|
- provinceId (número entero): identificador de la provincia donde se genera el evento según el [INE](https://www.ine.es/daco/daco42/codmun/cod_provincia_estandar.htm)
|
|
|
|
|
|
- road (número entero): nombre oficial de la carretera donde se genera el evento
|
|
|
|
|
|
- pk (número entero): punto kilométrico donde se genera el evento
|
|
|
|
|
|
- direction (texto): dirección de la carretera donde se genera el evento. UP = Sentido ascendente, DOWN = Sentido descendente, UNKNOWN = Desconocido
|
|
|
|
|
|
Se puede encontrar más información y un ejemplo de conexión [aquí](https://gitlab.cmobility30.es/dgt3.0_esp/general/-/wikis/MQTT).
|
|
|
|
|
|
**Nota:** *La información que se está publicando en el entorno de desarrollo es una simulación con información no real que va cambiando a lo largo del día, de forma que se pueda probar la interface de consumo.* |