Usuários
A funcionalidade de gerenciamento de usuários permite cadastrar, atualizar e remover as tags veiculares autorizadas em cada antena. Os usuários representam os veículos habilitados para acesso, com base em critérios como tag, grupo, horários e permissões especiais.
1. Obter Usuários (por Instância)
Descrição:
Retorna a lista completa de usuários (tags) cadastrados na antena acessada via instância. Inclui dados como número da tag, grupo associado, horários, entre outros.
GET /api/v1/vehicleAntennas/instances/{id}/users
Quando Usar:
Para consultar usuários de uma antena recém-descoberta.
Durante diagnósticos ou sincronização com o banco de dados do sistema.
Obter os usuários da antena de tag veicular por Instância conectada, o parâmetro usersIndex é usado para paginar os resultados e deve estar entre 0 e 99.
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Índice da página
0Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
2. Atualizar Usuários (por Instância)
Descrição:
Envia uma nova lista de usuários que substituirá a configuração atual da antena acessada via instância. Essa atualização sobrescreve todos os dados anteriores de usuários.
POST /api/v1/vehicleAntennas/instances/{id}/users
Quando Usar:
Na configuração inicial da antena.
Para atualizar o banco de tags em massa antes de cadastrar a antena definitivamente.
Atualizar usuário da antena de tag veicular por Instância conectada. Quando o "userId" já existir na memória da Antena, o usuário será atualizado, caso contrário, usuário será adicionado.
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a atualização ocorrer com sucesso
Quando ocorrer erro
3. Remover Usuários (por Instância)
Descrição:
Remove todos os usuários cadastrados na antena acessada pela instância. Essa operação zera a base de tags autorizadas.
DELETE /api/v1/vehicleAntennas/instances/{id}/users
Quando Usar:
Para limpar a memória de usuários antes de uma nova configuração.
Em procedimentos de segurança ou redefinição do dispositivo.
Remover todos os usuários da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
4. Obter usuário da antena de tag veicular (por Instância)
Descrição:
Consulta os dados de um usuário por meio de uma instância conectada.
GET /api/v1/vehicleAntennas/instances/{id}/users/{userId}
Quando Usar:
Utilize para acessar as informações do usuário de uma antena já conectada, como parte de um sistema em tempo real.
Obter usuário da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Id do usuário
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
5. Remover usuário da antena de tag veicular (por Instância)
Descrição:
Remove um usuário específico da antena via instância conectada.
DELETE /api/v1/vehicleAntennas/instances/{id}/users/{userId}
Quando Usar:
Aplicável quando a antena está sendo acessada diretamente e deseja-se remover um usuário sem depender do ID cadastrado.
Remover usuário da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Id do usuário
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
6. Obter o próximo id de usuário livre da antena de tag veicular (por Instância)
Descrição:
Obtém o próximo ID de usuário disponível por meio da instância.
GET /api/v1/vehicleAntennas/instances/{id}/users/identities
Quando Usar:
Indicado em operações conectadas diretamente à antena, como aplicações móveis ou painéis de configuração em campo.
Obter o próximo id de usuário livre da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
7. Obter Usuários (por ID)
Descrição:
Retorna os usuários cadastrados na antena com ID já conhecido e ativo no sistema. Essa consulta traz dados detalhados da configuração atual.
GET /api/v1/vehicleAntennas/{id}/users
Quando Usar:
Para verificar os acessos ativos e suas configurações.
Durante auditorias ou suporte.
Obter os usuários da antena de tag veicular, o parâmetro usersIndex é usado para paginar os resultados e deve estar entre 0 e 99.
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Índice da página
0Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
8. Atualizar Usuários (por ID)
Descrição:
Envia uma nova configuração de usuários para a antena cadastrada (identificada por ID). Todos os dados anteriores de usuários são sobrescritos.
POST /api/v1/vehicleAntennas/{id}/users
Quando Usar:
Para sincronizar a lista de usuários com o sistema central.
Em alterações de grupo ou políticas de acesso.
Atualizar usuário da antena de tag veicular. Quando o "userId" já existir na memória da Antena, o usuário será atualizado, caso contrário, usuário será adicionado.
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a atualização ocorrer com sucesso
Quando ocorrer erro
9. Remover Usuários (por ID)
Descrição:
Remove todos os usuários da antena com base no ID cadastrado no sistema. É uma operação irreversível.
DELETE /api/v1/vehicleAntennas/{id}/users
Quando Usar:
Para resetar a base de usuários.
Em caso de troca de ambientes ou descontinuação do uso da antena.
Remover todos os usuários da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
10. Obter usuário da antena (por ID)
Descrição:
Retorna os dados de um usuário específico da antena, identificado pelo userId.
GET /api/v1/vehicleAntennas/{id}/users/{userId}
Quando Usar:
Utilize para consultar as credenciais ou configurações de um usuário previamente cadastrado.
Obter usuário da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
11. Remover usuário (por ID)
Descrição:
Remove um usuário específico da antena.
DELETE /api/v1/vehicleAntennas/{id}/users/{userId}
Quando Usar:
Use para revogar o acesso de um usuário em particular sem afetar os demais cadastros.
Remover usuário da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
12. Obter o próximo id livre (por ID)
Descrição:
Retorna o próximo ID de usuário disponível para cadastro
GET /api/v1/vehicleAntennas/{id}/users/identities
Quando Usar:
Ideal para sistemas que gerenciam usuários de forma automatizada e precisam saber qual ID ainda está livre antes de realizar uma inserção.
Obter o próximo id de usuário livre da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
Atualizado