A especificação do método API pode ser encontrada em https://developers.omnicomm-world.com

Por favor, entre em contato com o suporte técnico Omnicomm escrevendo por e-mail para [email protected] para obter os direitos de uso do REST API

Deve ser indicado um token JWT no cabeçalho de autorização ao acessar os métodos REST API (exceto para os métodos de autorização). Este token JWT concede o direito de uso do REST API.

Formato do JWT: JWT<espaço><JWT recebido pelo método de autorização>

Exemplo:

Autorização: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTU3MDM1OTEsImxvZ2luIjoiYWR0…4ifQ.0I0CXcwWWxZWARE0eUEPOAvKd0prW_Uf0jbOMLnd5SI

O dia de expiração do JWT é indicado no atributo payload exp no formato de registro de hora Unix em UTC. Após a expiração aparecerá o erro 401 ao tentar acessar o método.

O JWT pode ser obtido usando o método POST /auth/login?jwt=1 ou, ao expirar, post /auth/refresh indicando o cabeçalho renovado de autorização obtido pelo JWT durante a autorização de post /auth/login?jwt=1.

A gestão de usuários abrange a adição, exclusão e bloqueio dos usuários no Omnicomm Online, além da obtenção de uma lista de todos os usuários do Omnicomm Online.

Um usuário autorizado pode acessar os dados do veículo.

Um sistema externo pode desempenhar as tarefas em nome de um usuário após fazer login com os seus dados de acesso (após obter o JWT com o direito do usuário).

Descrição dos métodos de gestão do usuário: https://developers.omnicomm-world.com/#/Users/

É necessário adicionar um perfil do veículo para habilitar o processamento dos dados do veículo na Omnicomm Online.

Um veículo é identificado por meio de um identificador único universal (UUID), o qual é atribuído quando ao adicionar-se um novo perfil de veículo no Omnicomm Online, ou através do número de identificação do terminal.

Os veículos podem ser adicionados a grupos, e o mesmo veículo pode pertencer a mais de um grupo. Também é possível configurar o acesso aos grupos de veículos pelos usuários. Os grupos de veículos são criados ao adicionar os usuários, bem como na interface do Omnicomm Online.

Descrição dos métodos de gerenciamento dos veículos: https://developers.omnicomm-world.com/#/Vehicles/

As cercas eletrônicas são áreas virtuais no mapa criadas pelos usuários no Оmnicomm Оnline. Ao criar uma cerca eletrônica, especifique uma forma (polígono, círculo ou linha) e suas coordenadas geográficas.

As cercas eletrônicas são usadas para monitorar a localização do veículo (entrando ou saindo da cerca eletrônica) e outros parâmetros de operação, como a velocidade do veículo.

Descrição dos métodos de gerenciamento das cercas eletrônicas: https://developers.omnicomm-world.com/#/Geozones/

As notificações são usadas para notificar imediatamente os usuários sobre os eventos gravados.

Descrição dos métodos de tratamento das notificações: https://developers.omnicomm-world.com/#/Notifications/

Os relatórios são usados para obter diversas informações sobre a operação do veículo.

Descrição dos métodos de obtenção dos relatórios: https://developers.omnicomm-world.com/#/Reports/

O serviço de vídeo Omnicomm abrange o gerenciamento de terminais de vídeo e fornece ao usuário material em vídeo.

Características principais do serviço:

• receber, armazenar, modificar e fornecer dados dos perfis dos terminais de vídeo
• receber, armazenar, modificar e fornecer parâmetros da tarefa para o download de arquivos de vídeo
• executar tarefas de download de arquivos de vídeo

Descrição dos métodos para gestão do serviço de vídeo: https://developers.omnicomm-world.com/#/VideoService/

Esta seção descreve como usar o serviço de vídeo num cenário típico.

Para obter um trecho de vídeo:

1. Faça login na conta de um revendedor ou usuário com direitos sobre o veículo e direitos de uso do serviço de vídeo: POST /auth/login?jwt=1

2. Obter o perfil do veículo a partir do ID do terminal do veículo: GET /service/ovms/api/profiles

3. Obter o arquivo de vídeo:

• Crie uma tarefa para obter o trecho de vídeo com base no perfil de vídeo recebido: POST /service/ovms/api/tasks

• Verificar periodicamente o status da tarefa: GET /service/ovms/api/tasks/{task_id}

• Após receber o status “pronto” da tarefa, solicite o arquivo de vídeo:GET /service/ovms/api/tasks/file/{task_id}

Há restrições sobre a intensidade das solicitações que podem ser enviadas para o REST API do Onmicomm Online para protegê-lo contra ataques DoS e erros de sistemas de terceiros.

Quando essas restrições são extrapoladas, todas as solicitações feitas ao REST API provenientes do endereço IP ou usuário correspondente serão bloqueadas.

Não superiores a 10 por minuto pelo mesmo endereço IP.

Não superiores a 180 por minuto do mesmo usuário.

Não superiores a 60 por minuto pelo mesmo endereço IP.