Skip to content

home

Jump to bottom
DGT 3.0 edited this page Nov 14, 2024 · 16 revisions

El caso de uso 17 está dedicado a la información relativa a la recepción y publicación en tiempo real de la posición de los trabajadores en la carretera cuando estos presenten un riesgo para sí mismos o para los conductores. Este servicio incluye la información generada por los Chalecos Conectados

Esta información podrá ser enviada a la plataforma DGT 3.0 o bien por dispositivos de IoT o bien por Apps que se puedan utilizar para posicionar estos elementos en la vía. La plataforma cuenta con dos funcionalidades diferenciadas para la publicación (envío) y para la suscripción (recepción) de información. La primera es a través de una API REST y la segunda a través de un servicio MQTT en tiempo real. La funcionalidad de publicación requiere de certificados de acceso que deben ser solicitados y suministrados por DGT 3.0. Estos certificados, de no haber sido solicitados ya, se deberán solicitar a soporte@cmobility30.es.

A continuación se muestra la URL con las que se accede a la funcionalidad:

Modo URL Descripción
Publicación https://pre.cmobility30.es/use-case-17 Endpoint del entorno de integración de clientes para la publicación
Suscripción ssl://production.cmobility30.es:8883 Endpoint para la suscripción

A continuación se describen las dos funcionalidades.

Publicación

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:

General · (cmobility30.es)

  • Los detalles de las tablas maestras y datos que pueden componer el evento:

Tablas Maestras

  • Información relativa al evento que se debe enviar:

Evento

Suscripción

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 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 al tópico:

out_usecase17_vests

En el tópico se publican los eventos en formato JSON. Aquí se puede ver un ejemplo:

{
    "actionId": "94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2",
    "timestamp": "2024-09-03T07:26:02Z",
    "lon": -4.400742,
    "lat": 36.740297,
    "eventTypeId": 2
}

  • actionId (texto): Identificador único del evento

  • 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. Posibles valores: 2 = Dentro de zona de riesgo, 3 = Salida de zona de riesgo

Se puede encontrar más información y un ejemplo de conexión aquí.

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.

Errores

Como se ha indicado anteriormente, todas las respuestas HTTP que no sean 200 – OK, se pueden considerar inválidas. El formato de la respuesta de error es como el siguiente ejemplo:

{
    "status": 401,
    "code": 1,
    "message": "User not found or valid"
}

Estos errores tendrán tres categorías principales:

Error de Autentificación

  • HTTP Status: 401 - Unauthorized
    Code Message
    1 User not found or valid

Error de Cliente

  • HTTP Status: 400 - Bad Request
    Code Message
    0 Authenticate
    2 Entity ID not found
    3 Missing required property
    4 The entity received cannot be proccessed
    5 Incorrect token received
    6 Expired token received
    7 There is an error with the token provided. Please request a new one
    8 No token received
    9 Required request body is missing
    10 Event is marked as expired by timestamp
    11 Missing request header
    12 Permission denied. Role assigned to user missing
    13 There is an error in one or more elements of the list
    14 The actionId must be unique. This one has been already used
    15 The event type is 3. However, event has not been started
    16 The event has already been marked as finished
    17 The event has already been marked as started
    19 The event had been marked as finished automatically
    20 The event type must be between 2 and 3
    21 The event is in the future
    22 The event is outside the Spanish territory

En el caso de obtener un error 3 - Missing required property la respuesta obtenida tendrá un valor en el message que nos indicará los campos que faltan por enviar:

{
    "status": 400,
    "code": 3,
    "message": "[beaconTypeId: must not be null, lon: must not be null]"
}

Error de Servidor

  • HTTP Status: 500 - Internal Server Error
    Code Message
    17 Internal error
Clone this wiki locally