Descoberta e Conexão
Esta seção agrupa os comandos responsáveis por localizar automaticamente os controladores MG3000 na rede local, além de realizar e gerenciar conexões com esses dispositivos. Esses comandos são essenciais durante o processo de instalação, configuração inicial ou manutenção remota, garantindo que os dispositivos estejam corretamente conectados à aplicação.
1. Localizar Controlador na Rede
Descrição:
Realiza a varredura da rede local utilizando o protocolo UDP para detectar controladores MG3000 disponíveis.
POST /api/v1/accessControllers/discoveries
Quando Usar:
Utilize este comando quando precisar localizar controladores que ainda não foram cadastrados no sistema, geralmente durante a configuração inicial ou diagnóstico de conectividade.
Localizar o controlador de acesso MG3000 na rede local via UDP
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Endereço IP para qual o controlador de acesso deverá responder
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a localização ocorrer com sucesso
Quando ocorrer erro
2. Conectar Controlador (Módulo Guarita)
Descrição:
Estabelece a conexão entre a aplicação e o controlador MG3000 através do Módulo Guarita, utilizando os parâmetros de rede previamente definidos.
POST /api/v1/accessControllers/connections
Quando Usar:
Use para conectar-se ao dispositivo após descobri-lo ou cadastrá-lo, principalmente em implantações que utilizam a arquitetura com Módulo Guarita.
Conectar um controlador de acesso (Módulo Guarita MG3000)
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a conexão ocorrer com sucesso
Quando ocorrer erro ao conectar
3. Consultar Conexões Ativas do Controlador (Módulo Guarita)
Descrição:
Obtém as conexões ativas entre a aplicação e o controlador MG3000 através do Módulo Guarita, permitindo verificar o status de comunicação em tempo real.
GET /api/v1/accessControllers/connections
Quando Usar:
Para monitorar quais controladores estão atualmente conectados ao sistema.
Útil em diagnósticos de comunicação e na verificação do status de conectividade em tempo real.
Exibir as conexões ativas com controlador de acesso (Módulo Guarita MG3000)
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Quando a ocorrer com sucesso
Quando ocorrer erro
4. Conectar Controlador por ID
Descrição:
Realiza a conexão com um controlador MG3000 previamente cadastrado no sistema,
POST /api/v1/accessControllers/{id}/connections
Quando Usar:
Ideal para restabelecer a conexão com um controlador específico, como em casos de reconexão após falha, reinicialização do sistema ou manutenção.
Conectar um controlador de acesso MG3000 através do Id
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a conexão ocorrer com sucesso
Quando ocorrer erro ao conectar
5. Desconectar Controlador (por Instância)
Descrição:
Realiza a desconexão com um controlador MG3000 previamente cadastrado no sistema, com base em uma instância de conexão específica.
POST/api/v1/accessControllers/instances/{id}/disconnections
Quando Usar:
Ideal para desconectar um controlador específico, quando não for mais necessário manter a comunicação ativa, como ao finalizar um turno, encerrar testes ou liberar recursos do sistema.
Desconectar um controlador de acesso MG3000 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 ocorrer com sucesso
Quando ocorrer erro
6. Desconectar Controlador por ID
Descrição:
Realiza a desconexão com um controlador MG3000 previamente cadastrado no sistema, com base no seu ID.
POST /api/v1/accessControllers/{id}/disconnections
Quando Usar:
Ideal para desconectar um controlador específico, quando não for mais necessário manter a comunicação ativa, como ao finalizar um turno, encerrar testes ou liberar recursos do sistema.
Desconectar um controlador de acesso MG3000
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
Atualizado