Modos da API: Instância e Base de Dados

A API foi projetada para oferecer flexibilidade de gerenciamento e comunicação com os dispositivos em diferentes contextos de operação. Para isso, ela suporta dois modos principais de interação:

Modo Instância (Tempo Real)

Este modo refere-se à comunicação direta com um dispositivo conectado no momento, geralmente descoberta via rede local (UDP) e mantida por uma sessão ativa.

• Identificação: Utiliza instances/{id} como parte do endpoint.

• Acesso: Realizado com base na conexão ativa estabelecida com o dispositivo.

Exemplo: GET /api/v1/vehicleAntennas/instances/{id}/logs → Recupera os logs da antena diretamente conectada.

---

Modo Base de Dados (Gerenciamento Cadastral)

Neste modo, as operações são realizadas com base nas informações persistidas no sistema, relacionadas a antenas previamente cadastradas na base de dados.

• Identificação: Utiliza apenas {id} nos endpoints.

• Acesso: Não depende estar conectado no momento.

Exemplo: POST /api/v1/vehicleAntennas/{id}/users → Atualiza ou insere um usuário cadastrado na antena pelo ID no sistema.

---

Equivalência entre Modos

Vários endpoints possuem versões equivalentes para os dois modos. A escolha entre um ou outro depende do objetivo da ação:

Operação	Por ID (Base de Dados)	Por Instância (Tempo Real)
Obter logs	/vehicleAntennas/{id}/logs	/vehicleAntennas/instances/{id}/logs
Atualizar data/hora	/vehicleAntennas/{id}/timestamps	/vehicleAntennas/instances/{id}/timestamps
Gerenciar usuários	/vehicleAntennas/{id}/users	/vehicleAntennas/instances/{id}/users
Reiniciar antena	/vehicleAntennas/{id}/restarts	/vehicleAntennas/instances/{id}/restarts

---

Controle de AcessoMódulo GuaritaControladores FaciaisAntena Veicular