Eventos
Esta seção agrupa os comandos responsáveis por interagir com o log de eventos gerado pelos controladores de acesso MG3000. Os eventos são registros de todas as atividades detectadas pelo equipamento, como acessos permitidos/negados, status de sensores e operações do sistema. Esses endpoints permitem consultar, quantificar e gerenciar esses registros para fins de auditoria, monitoramento em tempo real e manutenção.
1. Obter Eventos (por Instância)
Descrição:
Consulta e retorna a lista de todos os eventos registrados por um controlador de acesso MG3000, utilizando o ID de uma instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/events
Quando Usar:
Para realizar uma auditoria completa ou carregar o histórico de atividades de um dispositivo específico que está conectado.
Para exibir a lista de todos os registros de um controlador em uma interface de monitoramento ou relatório.
Obter os eventos por pacotes do controlador de acesso MG3000 por Instância conectada, cada pacote contém 67 eventos, todos os pacotes serão obtidos ao não informar a quantidade de pacotes.
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 da conexão
Quantidade de pacotes de eventos a obter
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
2.Remover Eventos (por Instância)
Descrição
Remove (limpa) todos os eventos do log de um controlador de acesso, utilizando o ID da instância de conexão ativa.
DELETE /api/v1/accessControllers/instances/{id}/events
Quando Usar:
Após realizar um backup ou auditoria, para liberar espaço de armazenamento no dispositivo.
Para reiniciar o log de eventos em um ambiente de testes ou após uma manutenção crítica.
Remover os eventos registrados no controlador de acesso MG3000 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 da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
3. Obter Eventos (Progressivo por Instância)
Descrição:
Obtém apenas os novos eventos gerados desde a última consulta, funcionando como uma fila. Utiliza o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/events/progress
Quando Usar:
Para implementar um monitoramento em tempo real, buscando apenas as atualizações mais recentes sem processar o histórico completo a cada chamada.
Para alimentar dashboards ou sistemas de notificação que precisam reagir a novas atividades instantaneamente.
Obter os eventos de forma progressiva do controlador de acesso MG3000 por Instância conectada, todos os eventos serão obtidos ao não informar a quantidade de eventos desejados.
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 da conexão
Quantidade de eventos a obter
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. Definir Evento como Lido (por Instância)
Descrição:
Marca um evento automático específico como "lido" no controlador, utilizando o ID da instância de conexão ativa.
POST /api/v1/accessControllers/instances/{id}/events/read
Quando Usar:
Para gerenciar um fluxo de trabalho onde os eventos automáticos precisam ser reconhecidos ou processados por um operador ou sistema.
Para ocultar eventos já tratados de uma visualização de "novos eventos", mantendo a interface do usuário limpa.
Definir evento automático como lido no 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 da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
5. Obter Total de Eventos (por Instância)
Descrição:
Retorna o número total de eventos registrados no log do controlador, utilizando o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/events/total
Quando Usar:
Para exibir um contador rápido do volume de atividades em um painel de controle, sem precisar carregar a lista completa de eventos.
Para monitorar o crescimento do log e planejar ações de manutenção, como a limpeza dos registros.
Obter total de eventos 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 da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
6. Obter Total de Eventos Distintos (por Instância)
Descrição:
Retorna o número total de tipos de eventos únicos (distintos) registrados pelo controlador, utilizando o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/events/totalDistinct
Quando Usar:
Para entender a variedade de atividades que ocorrem em um dispositivo, identificando se apenas eventos comuns estão sendo registrados ou se há ocorrências raras.
Para otimizar interfaces de filtro, mostrando apenas os tipos de eventos que de fato ocorreram.
Obter total de eventos distintos 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 da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
7. Obter Eventos (por ID)
Descrição:
Consulta e retorna a lista de todos os eventos de um controlador, utilizando o ID do dispositivo registrado no sistema.
GET /api/v1/accessControllers/{id}/events
Quando Usar:
Para obter o histórico de eventos de um controlador que pode não estar ativamente conectado via instância no momento da consulta.
Para operações de backend ou relatórios que precisam acessar dados de qualquer dispositivo registrado, independentemente de seu status de conexão.
Obter os eventos por pacotes do controlador de acesso MG3000, cada pacote contém 67 eventos, todos os pacotes serão obtidos ao não informar a quantidade de pacotes.
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
Quantidade de pacotes de eventos a obter
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
8. Remover Eventos (por ID)
Descrição:
Remove (limpa) todos os eventos do log de um controlador, utilizando o ID do dispositivo registrado no sistema.
DELETE /api/v1/accessControllers/{id}/events
Quando Usar:
Para executar rotinas de limpeza de logs em massa ou agendadas, que operam sobre os controladores registrados sem depender de uma conexão ativa.
Para permitir que um administrador limpe o histórico de um dispositivo remotamente através de uma interface de gerenciamento.
Remover os eventos registrados no 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
9. Obter Eventos (Progressivo por ID)
Descrição:
Obtém apenas os novos eventos gerados desde a última consulta, utilizando o ID do controlador registrado no sistema.
GET /api/v1/accessControllers/{id}/events/progress
Quando Usar:
Para serviços de monitoramento assíncrono que verificam novos eventos em múltiplos dispositivos, sem a necessidade de manter uma conexão persistente com cada um.
Para coletar dados de forma eficiente em sistemas distribuídos, onde a conexão direta por instância não é sempre viável.
Obter os eventos de forma progressiva do controlador de acesso MG3000, todos os eventos serão obtidos ao não informar a quantidade de eventos desejados.
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
Quantidade de eventos a obter
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. Definir Evento como Lido (por ID)
Descrição:
Marca um evento automático específico como "lido", utilizando o ID do controlador registrado no sistema.
POST /api/v1/accessControllers/{id}/events/read
Quando Usar:
Para sistemas de processamento em lote (batch) que analisam e marcam eventos como tratados, sem interagir com a instância de conexão.
Para permitir que um sistema de gerenciamento centralizado atualize o status de eventos em nome de um operador.
Definir evento automático como lido no 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
11. Obter Total de Eventos (por ID)
Descrição:
Retorna o número total de eventos registrados no log do controlador, utilizando o ID do dispositivo registrado no sistema.
GET /api/v1/accessControllers/{id}/events/total
Quando Usar:
Para gerar relatórios agregados sobre o volume de eventos em todos os controladores cadastrados.
Para popular dashboards de visão geral que mostram estatísticas de dispositivos, mesmo que estejam offline.
Obter total de eventos
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-USOK
Bad Request
12. Obter Total de Eventos Distintos (por ID)
Descrção:
Retorna o número total de tipos de eventos únicos (distintos) registrados pelo controlador, utilizando o ID do dispositivo no sistema.
GET /api/v1/accessControllers/{id}/events/totalDistinct
Quando Usar:
Para análises estatísticas sobre a diversidade de eventos em toda a base de controladores instalados.
Para identificar rapidamente se um dispositivo específico está registrando tipos de eventos anormais em comparação com outros.
Obter total de eventos distintos
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-USOK
Bad Request
13. Interromper Timeout Progressivo (por Instância)
Descrição:
Envia um comando para forçar a interrupção imediata de qualquer operação progressiva (como GET /events/progress) que esteja em andamento e aguardando um timeout. Utiliza o ID de uma instância de conexão ativa.
POST /api/v1/accessControllers/instances/{id}/progress/timeouts/stops
Quando Usar
Para cancelar uma chamada de longa duração a um endpoint progressivo sem ter que esperar o timeout natural, liberando a conexão.
Para implementar um botão de "cancelar" em uma interface de usuário que está monitorando eventos em tempo real.
Interromper timeout dos comandos progressivos 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 da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando ocorrer com sucesso
Quando ocorrer erro
14. Interromper Timeout Progressivo (por ID)
Descrição:
Dispara um comando para interromper uma operação progressiva em um controlador, utilizando o ID do dispositivo registrado no sistema.
POST /api/v1/accessControllers/{id}/progress/timeouts/stops
Quando Usar:
Para que um sistema de gerenciamento central possa encerrar uma conexão de monitoramento pendente em um dispositivo remoto.
Em rotinas de automação para garantir que nenhuma conexão de longa duração fique aberta indefinidamente em um controlador.
Interromper timeout dos comandos progressivos do 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