Usted puede encontrar la especificación del método API en https://developers.omnicomm-world.com

Comuníquese con el soporte técnico de Omnicomm por correo electrónico a [email protected] para obtener los derechos para utilizar REST API

Un token JWT debe estar indicado en el encabezado de Autorización al acceder los métodos REST API (excepto para los métodos de autorización). Este token JWT le otorga el derecho a usar REST API.

Formato JWT: JWT<espacio><el JWT recibido del método de autorización>

Ejemplo:

Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTU3MDM1OTEsImxvZ2luIjoiYWR0...4ifQ.0I0CXcwWWxZWARE0eUEPOAvKd0prW_Uf0jbOMLnd5SI

La fecha de expiración de JWT se indica en el atributo de carga útil exp en el formato Unix Time Stamp en UTC. Después de la expiración, aparecerá Error 401 No autorizado al acceder el método.

Se puede obtener el JWT usando el siguiente método POST /auth/login?jwt=1 o, al expirar, post /auth/refresh al indicar en el encabezado de actualizar de la Autorización, el JWT obtenido durante la autorización del post /auth/login?jwt=1.

La gestión de usuario cubre la adición, el borrado, y el bloqueo de usuarios en Omnicomm Online, así como obtener un listado de todos los usuarios de Omnicomm Online.

Un usuario autorizado puede acceder los datos del vehículo.

Un sistema externo puede realizarle las tareas al usuario después de iniciar sesión bajo su cuenta (después de obtener el JWT con el derecho del usuario).

Descripción de los métodos de gestión de usuario: https://developers.omnicomm-world.com/#/Users/

Es necesario agregar un perfil del vehículo para activar el procesamiento de datos del vehículo en Omnicomm Online.

Un vehículo se identifica con el identificador de cadena único (UUID), el cual es asignado al agregar un vehículo nuevo a Omnicomm Online o con el número de identificación de la terminal.

Se pueden agregar vehículos a los grupos, y dicho vehículo puede pertenecer a más de un grupo. También se puede configurar el acceso a los grupos de vehículos para los usuarios. Los grupos de vehículos se crean al crear un usuario, así como en la interfaz Omnicomm Online.

Descripción de los métodos de gestión de vehículo: https://developers.omnicomm-world.com/#/Vehicles/

Las geocercas son áreas virtuales en el mapa creadas por los usuarios en

Оmnicomm Оnline. Al crear una geocerca, especifique su forma (un polígono, un círculo, o una línea) y sus coordenadas geográficas.

Las geocercas se usan para monitorear la ubicación de un vehículo (entrando/saliendo una geocerca) y otros parámetros de funcionamiento, así como la velocidad del vehículo.

Descripción de los métodos de gestión de geocerca: https://developers.omnicomm-world.com/#/Geozones/

Las notificaciones se usan para notificar a los usuarios de inmediato sobre los eventos registrados.

Descripción de métodos para el manejo de notificaciones: https://developers.omnicomm-world.com/#/Notifications/

Los informes se usan para obtener información variada sobre el funcionamiento del vehículo.

Descripción de los métodos de obtención de informes: https://developers.omnicomm-world.com/#/Reports/

El servicio de vídeo de Omnicomm se encarga de la gestión de la terminal de vídeo y brinda material de vídeo al usuario.

Características principales del servicio:

• recepción, almacenaje, modificación, y provisión de datos de los perfiles de la terminal de vídeo
• recepción, almacenaje, modificación, y provisión de los parámetros de tareas para la descarga de archivos de vídeo
• ejecución de las tareas de descarga de archivos de vídeo

Descripción de métodos para el manejo del servicio de vídeo: https://developers.omnicomm-world.com/#/VideoService/

Esta selección describe cómo usar el servicio de vídeo en una situación típica.

Para obtener un fragmento de vídeo:

1. Inicie sesión a la cuenta de un distribuidor o un usuario que tenga derechos al vehículo o usar el servicio de vídeo: POST /auth/login?jwt=1

2. Obtenga el perfil de vídeo del identificador de la terminal del vehículo: GET /service/ovms/api/profiles

3. Obtenga el archivo de vídeo:

• Crea una tarea para obtener el fragmento de vídeo basado en el perfil de vídeo recibido: POST /service/ovms/api/tasks

• Verifique de manera periódica el estado de la tarea: GET /service/ovms/api/tasks/{task_id}

• Después de recibir el estado de “Hecho” de la tarea, solicite el archivo de vídeo:GET /service/ovms/api/tasks/file/{task_id}

Hay restricciones sobre la intensidad de las solicitudes que se envían a Omnicomm Online REST API para protegerlo contra los ataques DoS y errores de los sistemas de otros fabricantes.

Cuando estas restricciones son excedidas, se bloqueará cualquier solicitud de la dirrección IP o usuario correspondiente al REST API.

No mayor a 10 en 1 minuto desde la misma dirección IP.

No mayor a 180 en 1 minuto por cada usuario.

No mayor a 60 en un minuto desde la misma dirección IP.