gearConfigurações

Esta seção concentra os endpoints responsáveis pela leitura e atualização de todos os parâmetros de configuração do controlador MG3000. Esses comandos permitem desde a consulta completa das configurações atuais até a modificação granular de parâmetros básicos e avançados, como rede, alertas, temporizadores e modos de operação. A seção também inclui o comando para restaurar o equipamento aos seus padrões de fábrica.

1. Obter Configurações do Controlador (por Instância)

Descrição:

Consulta e retorna o conjunto completo de configurações atuais do controlador de acesso MG3000, utilizando o ID de uma instância de conexão ativa.

  • GET /api/v1/accessControllers/instances/{id}/settings

Quando Usar:

  • Para carregar todas as configurações de um dispositivo em uma tela de gerenciamento antes de permitir que o usuário faça alterações.

  • Para realizar um backup completo das configurações de um controlador como um único objeto JSON.

Obter configurações do controlador de acesso MG3000 por Instância conectada

get

Obter configurações do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a obtenção do endereço ocorrer com sucesso

application/json
get
/api/v1/accessControllers/instances/{id}/settings

2. Obter Configurações do Controlador (por ID)

Descrição:

Consulta e retorna o conjunto completo de configurações de um controlador, utilizando o ID do dispositivo registrado no sistema.

  • GET /api/v1/accessControllers/{id}/settings

Quando Usar:

  • Para que um sistema de gerenciamento central possa ler e exibir as configurações de qualquer dispositivo, independentemente de seu status de conexão.

  • Para auditar ou fazer backup das configurações de um dispositivo de forma assíncrona.

Obter configurações do controlador de acesso MG3000

get

Obter configurações do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

Quando a obtenção ocorrer com sucesso

application/json
get
/api/v1/accessControllers/{id}/settings

3. Atualizar Configurações Básicas (por Instância)

Descrição:

Envia e aplica um conjunto de configurações básicas ao controlador, como nome do dispositivo e parâmetros operacionais gerais, utilizando o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/basics

Quando Usar:

  • Durante a configuração inicial de um novo dispositivo para definir seus parâmetros fundamentais.

  • Para fazer ajustes rápidos em configurações gerais sem precisar reenviar todas as configurações avançadas.

Atualizar configurações básicas do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações básicas do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
timePushButtoninteger · int32Opcional
numberLogsinteger · int32Opcional
timeLogsinteger · int32Opcional
counterUpdatesinteger · int32Opcional
timeAwakensConciergeinteger · int32Opcional
timeStartAwakensConciergeinteger · int32Opcional
timeEndAwakensConciergeinteger · int32Opcional
relaySecondsAwakensConciergeinteger · int32Opcional
relaySecondsPanicinteger · int32Opcional
serialBaudratestring · enumOpcionalValores possíveis:
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/basics

4. Atualizar Configurações Básicas (por ID)

Descrição:

Envia e aplica um conjunto de configurações básicas a um controlador, utilizando o ID do dispositivo registrado no sistema.

  • POST /api/v1/accessControllers/{id}/settings/basics

Quando Usar:

  • Para atualizar em massa as configurações básicas de múltiplos dispositivos através de um script ou painel administrativo.

  • Para alterar o nome ou parâmetros operacionais de um dispositivo que não está ativamente conectado.

Atualizar configurações básicas do controlador de acesso MG3000

post

Atualizar configurações básicas do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
timePushButtoninteger · int32Opcional
numberLogsinteger · int32Opcional
timeLogsinteger · int32Opcional
counterUpdatesinteger · int32Opcional
timeAwakensConciergeinteger · int32Opcional
timeStartAwakensConciergeinteger · int32Opcional
timeEndAwakensConciergeinteger · int32Opcional
relaySecondsAwakensConciergeinteger · int32Opcional
relaySecondsPanicinteger · int32Opcional
serialBaudratestring · enumOpcionalValores possíveis:
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/basics

5. Atualizar Configurações de Alertas (por Instância)

Descrição

Define como o controlador deve se comportar em relação a alertas, como arrombamento de porta ou tentativas de acesso negadas. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/alerts

Quando Usar:

  • Para habilitar ou desabilitar alertas sonoros (sirene) ou notificações para eventos de segurança específicos.

  • Para ajustar a sensibilidade ou o comportamento dos gatilhos de alerta do dispositivo.

Atualizar configurações de alertas do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de alertas do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
useGroupsbooleanOpcional
onlineUpdateinteger · int32Opcional
upsbooleanOpcional
routesbooleanOpcional
alertDoorViolatedbooleanOpcional
doorOpenedbooleanOpcional
digitalQualityinteger · int32Opcional
internetClockbooleanOpcional
channelInhibitedbooleanOpcional
digital2integer · int32Opcional
eventIndexedbooleanOpcional
timedPanicbooleanOpcional
openDoorAlertbooleanOpcional
conciergeDevicebooleanOpcional
conciergeSlaveModebooleanOpcional
outputProtocolinteger · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/alerts

6. Atualizar Configurações de Alertas (por ID)

Descrição:

Define as configurações de comportamento de alertas (como arrombamento) em um controlador, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/alerts

Quando Usar:

  • Para aplicar uma política de segurança de alertas padrão a um novo dispositivo cadastrado no sistema.

  • Para habilitar ou desabilitar remotamente a sirene de um dispositivo específico através de um painel de controle central.

Atualizar configurações de alertas do controlador de acesso MG3000

post

Atualizar configurações de alertas do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
useGroupsbooleanOpcional
onlineUpdateinteger · int32Opcional
upsbooleanOpcional
routesbooleanOpcional
alertDoorViolatedbooleanOpcional
doorOpenedbooleanOpcional
digitalQualityinteger · int32Opcional
internetClockbooleanOpcional
channelInhibitedbooleanOpcional
digital2integer · int32Opcional
eventIndexedbooleanOpcional
timedPanicbooleanOpcional
openDoorAlertbooleanOpcional
conciergeDevicebooleanOpcional
conciergeSlaveModebooleanOpcional
outputProtocolinteger · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/alerts

7. Atualizar Configurações de Autenticação (por Instância)

Descrição:

Ajusta os parâmetros relacionados à autenticação por senha (passcode), como o número de dígitos ou o tempo de bloqueio após tentativas falhas. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/auths

Quando Usar:

  • Para reforçar a política de segurança, exigindo senhas mais complexas ou definindo regras de bloqueio.

  • Para configurar o modo de operação do teclado ou leitor de senhas.

Atualizar configurações de 'passcode' do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de 'passcode' do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
tcp1Passcodestring | nuloOpcional
tcp2Passcodestring | nuloOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/auths

8. Atualizar Configurações de Autenticação (Passcode) (por ID)

Descrição:

Ajusta os parâmetros de autenticação por senha (passcode) de um controlador, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/auths

Quando Usar:

  • Para implementar uma nova política de segurança de senhas em todos os dispositivos gerenciados pelo sistema.

  • Para configurar as regras de bloqueio de um dispositivo específico remotamente.

Atualizar configurações de 'passcode' do controlador de acesso MG3000

post

Atualizar configurações de 'passcode' do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
tcp1Passcodestring | nuloOpcional
tcp2Passcodestring | nuloOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/auths

9. Atualizar Configurações de Botoeira (por Instância)

Descrição:

Configura o comportamento das entradas de botoeira física do controlador, definindo sua função (ex: liberar acesso, acionar pânico). Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/buttons

Quando Usar:

  • Para definir o que acontece quando um botão físico conectado ao controlador é pressionado.

  • Para habilitar ou desabilitar uma botoeira para acionamento de porta.

Atualizar configurações de botoeira do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de botoeira do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/buttons

10. Atualizar Configurações de Botoeira (por ID)

Descrição:

Configura o comportamento das entradas de botoeira física de um controlador, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/buttons

Quando Usar:

  • Para padronizar a função da botoeira (ex: sempre liberar acesso) em todos os controladores de um local.

  • Para ativar ou desativar a funcionalidade de botoeira de um dispositivo remotamente a partir de um sistema central.

Atualizar configurações de botoeria do controlador de acesso MG3000

post

Atualizar configurações de botoeria do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/buttons

11. Atualizar Configurações de Modo Cliente (por Instância)

Descrição:

Define os parâmetros para que o controlador opere em "modo cliente", conectando-se a um servidor central em vez de esperar conexões. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/clients

Quando Usar:

  • Para configurar dispositivos que estão em redes com restrições de firewall, permitindo que eles iniciem a comunicação com o servidor.

  • Para alternar o modo de comunicação do dispositivo entre servidor (padrão) e cliente.

Atualizar configurações de 'modo client' do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de 'modo client' do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
port1integer · int32Opcional
port2integer · int32Opcional
wordPosConnectionstring | nuloOpcional
host1string | nuloOpcional
host2string | nuloOpcional
keepAliveMinutesinteger · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/clients

12. Atualizar Configurações de Modo Cliente (por ID)

Descrição:

Define os parâmetros para que o controlador opere em "modo cliente", utilizando seu ID de registro no sistema.

  • POST /api/v1/accessControllers/{id}/settings/advanced/clients

Quando Usar:

  • Para provisionar um dispositivo para operar em modo cliente antes de enviá-lo para instalação em um local com rede restrita.

  • Para alterar o modo de comunicação de um dispositivo remotamente através de um painel de administração.

Atualizar configurações de 'modo client' do controlador de acesso MG3000

post

Atualizar configurações de 'modo client' do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
port1integer · int32Opcional
port2integer · int32Opcional
wordPosConnectionstring | nuloOpcional
host1string | nuloOpcional
host2string | nuloOpcional
keepAliveMinutesinteger · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/clients

13. Atualizar Configurações de Comandos (por Instância)

Descrição

Configura como o controlador deve interpretar e responder a comandos remotos específicos enviados pela API. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/commands

Quando Usar:

  • Para personalizar ou restringir quais comandos remotos o dispositivo aceitará.

  • Para ajustar parâmetros de execução de comandos, como tempos de acionamento de relés.

Atualizar configurações de 'comandos' do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de 'comandos' do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
command90booleanOpcional
command32booleanOpcional
command58booleanOpcional
command46booleanOpcional
command42booleanOpcional
command40booleanOpcional
command33booleanOpcional
command25booleanOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/commands

14. Atualizar Configurações de Comandos (por ID)

Descrição:

Configura como um controlador deve interpretar e responder a comandos remotos, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/commands

Quando Usar:

  • Para aplicar um perfil de permissões de comandos a um grupo de dispositivos.

  • Para ajustar o tempo de acionamento de relés de um dispositivo específico sem a necessidade de uma conexão direta.

Atualizar configurações de 'comandos' do controlador de acesso MG3000

post

Atualizar configurações de 'comandos' do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
command90booleanOpcional
command32booleanOpcional
command58booleanOpcional
command46booleanOpcional
command42booleanOpcional
command40booleanOpcional
command33booleanOpcional
command25booleanOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/commands

15. Atualizar Configurações de Emergência (por Instância)

Descrição:

Define o comportamento do controlador em situações de emergência, como a liberação automática de todas as portas ou o acionamento de um alarme geral. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/emergency

Quando Usar:

  • Para configurar um "botão de pânico" ou um modo de evacuação.

  • Para garantir que o dispositivo siga os protocolos de segurança da empresa em caso de uma emergência.

Atualizar configurações de 'emergência' do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de 'emergência' do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
passiveTagReceiverbooleanOpcional
cardReceiverbooleanOpcional
activeTagReceiverbooleanOpcional
remoteControlReceiverbooleanOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/emergency

16. Atualizar Configurações de Emergência (por ID)

Descrição:

Define o comportamento de um controlador em situações de emergência, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/emergency

Quando Usar:

  • Para garantir que todos os dispositivos de uma instalação sigam o mesmo protocolo de evacuação.

  • Para configurar remotamente a funcionalidade de pânico em um dispositivo gerenciado.

Atualizar configurações de 'emergência' do controlador de acesso MG3000

post

Atualizar configurações de 'emergência' do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
passiveTagReceiverbooleanOpcional
cardReceiverbooleanOpcional
activeTagReceiverbooleanOpcional
remoteControlReceiverbooleanOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/emergency

17. Atualizar Configurações de Eventos (por Instância)

Descrição:

Ajusta quais tipos de eventos o controlador deve registrar e/ou reportar, permitindo filtrar o log para incluir apenas informações relevantes. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/events

Quando Usar:

  • Para otimizar o armazenamento e o tráfego de rede, desabilitando o registro de eventos de baixa prioridade.

  • Para focar o monitoramento em eventos críticos de segurança, ignorando eventos puramente operacionais.

Atualizar configurações de 'eventos' do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de 'eventos' do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
electronicIntercombooleanOpcional
manualBackupPerformedbooleanOpcional
automaticBackupPerformedbooleanOpcional
receiverEventbooleanOpcional
performedRestorebooleanOpcional
sdCardRemovedbooleanOpcional
panicEventbooleanOpcional
cloningAttemptbooleanOpcional
receiversNotUpdatedbooleanOpcional
pcDrivebooleanOpcional
capDrivebooleanOpcional
changeProgUserbooleanOpcional
eventAwakensConciergebooleanOpcional
connectedEquipmentbooleanOpcional
passagebooleanOpcional
deviceTriggeredbooleanOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/events

18. Atualizar Configurações de Eventos (por ID)

Descrição:

Ajusta quais tipos de eventos o controlador deve registrar e/ou reportar, permitindo filtrar o log para incluir apenas informações relevantes. Utilizando seu ID de registro

  • POST /api/v1/accessControllers/{id}/settings/advanced/events

Quando Usar:

  • Para otimizar o armazenamento e o tráfego de rede, desabilitando o registro de eventos de baixa prioridade.

  • Para focar o monitoramento em eventos críticos de segurança, ignorando eventos puramente operacionais.

Atualizar configurações de 'eventos' do controlador de acesso MG3000

post

Atualizar configurações de 'eventos' do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
electronicIntercombooleanOpcional
manualBackupPerformedbooleanOpcional
automaticBackupPerformedbooleanOpcional
receiverEventbooleanOpcional
performedRestorebooleanOpcional
sdCardRemovedbooleanOpcional
panicEventbooleanOpcional
cloningAttemptbooleanOpcional
receiversNotUpdatedbooleanOpcional
pcDrivebooleanOpcional
capDrivebooleanOpcional
changeProgUserbooleanOpcional
eventAwakensConciergebooleanOpcional
connectedEquipmentbooleanOpcional
passagebooleanOpcional
deviceTriggeredbooleanOpcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/events

19. Atualizar Configurações de Sinalização (por Instância)

Descrição:

Configura os indicadores visuais e sonoros (LEDs, bipes) do controlador para sinalizar diferentes estados, como acesso concedido, negado ou sistema em espera. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/flags

Quando Usar:

  • Para personalizar o feedback fornecido ao usuário final durante a interação com o leitor.

  • Para adaptar a sinalização do dispositivo a diferentes ambientes (ex: modo silencioso).

Atualizar configurações de 'sinalização' do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de 'sinalização' do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
controlParkingSpacesbooleanOpcional
labelUnitstring · enumOpcionalValores possíveis:
doublePassEventbooleanOpcional
baudrateCanstring · enumOpcionalValores possíveis:
bipsGuaritabooleanOpcional
filterEventsstring · enumOpcionalValores possíveis:
awakensSilentConciergebooleanOpcional
silentPanicbooleanOpcional
speakAwakeConciergebooleanOpcional
controlParkingSpacesOptionstring · enumOpcionalValores possíveis:
overlayTriggeringbooleanOpcional
labelBlockstring · enumOpcionalValores possíveis:
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/flags

20. Atualizar Configurações de Sinalização (por ID)

Descrição:

Configura os indicadores visuais e sonoros (LEDs, bipes) de um controlador, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/flags

Quando Usar:

  • Para padronizar o feedback ao usuário (ex: LED verde para acesso, vermelho para negado) em toda a instalação.

  • Para ativar um "modo silencioso" em dispositivos localizados em áreas sensíveis a ruído.

Atualizar configurações de 'sinalização' do controlador de acesso MG3000

post

Atualizar configurações de 'sinalização' do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
controlParkingSpacesbooleanOpcional
labelUnitstring · enumOpcionalValores possíveis:
doublePassEventbooleanOpcional
baudrateCanstring · enumOpcionalValores possíveis:
bipsGuaritabooleanOpcional
filterEventsstring · enumOpcionalValores possíveis:
awakensSilentConciergebooleanOpcional
silentPanicbooleanOpcional
speakAwakeConciergebooleanOpcional
controlParkingSpacesOptionstring · enumOpcionalValores possíveis:
overlayTriggeringbooleanOpcional
labelBlockstring · enumOpcionalValores possíveis:
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/flags

21. Atualizar Configurações de Rede (por Instância)

Descrição:

Define os parâmetros de rede do controlador, como endereço IP, máscara de sub-rede, gateway e portas de comunicação. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/networks

Quando Usar:

  • Durante a instalação inicial do dispositivo na rede local.

  • Para alterar o endereço IP de um dispositivo ou movê-lo para uma VLAN diferente.

Atualizar configurações de rede do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de rede do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
ipAddressstring | nuloOpcional
subnetMaskstring | nuloOpcional
gatewaystring | nuloOpcional
primaryDNSstring | nuloOpcional
secondaryDNSstring | nuloOpcional
tcpMode2booleanOpcional
activateUdp1booleanOpcional
activateUdp2booleanOpcional
providerDdnsinteger · int32Opcional
dhcpbooleanOpcional
ddnsUserstring | nuloOpcional
ddnsPasswordstring | nuloOpcional
ddnsHostnamestring | nuloOpcional
htmlUserstring | nuloOpcional
htmlPasswordstring | nuloOpcional
htmlHostnamestring | nuloOpcional
portTcp1integer · int32Opcional
portTcp2integer · int32Opcional
portUdp1integer · int32Opcional
portUdp2integer · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/networks

22. Atualizar Configurações de Rede (por ID)

Descrição:

Define os parâmetros de rede de um controlador (IP, gateway, etc.), utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/networks

Quando Usar:

  • Para pré-configurar os parâmetros de rede de um dispositivo antes de sua instalação física.

  • Para alterar o endereço IP de um dispositivo remotamente a partir de um painel de administração central.

Atualizar configurações de rede do controlador de acesso MG3000

post

Atualizar configurações de rede do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
ipAddressstring | nuloOpcional
subnetMaskstring | nuloOpcional
gatewaystring | nuloOpcional
primaryDNSstring | nuloOpcional
secondaryDNSstring | nuloOpcional
tcpMode2booleanOpcional
activateUdp1booleanOpcional
activateUdp2booleanOpcional
providerDdnsinteger · int32Opcional
dhcpbooleanOpcional
ddnsUserstring | nuloOpcional
ddnsPasswordstring | nuloOpcional
ddnsHostnamestring | nuloOpcional
htmlUserstring | nuloOpcional
htmlPasswordstring | nuloOpcional
htmlHostnamestring | nuloOpcional
portTcp1integer · int32Opcional
portTcp2integer · int32Opcional
portUdp1integer · int32Opcional
portUdp2integer · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/networks

23. Atualizar Configurações de Tempo de Reset (por Instância)

Descrição:

Ajusta os temporizadores internos do controlador, como o tempo que um relé (porta) permanece acionado após um acesso ser concedido. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/resets

Quando Usar:

  • Para aumentar ou diminuir o tempo que uma porta fica aberta para passagem.

  • Para configurar tempos de rearme automático de sensores ou outros componentes.

Atualizar configurações de Tempo de Reset do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações de Tempo de Reset do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
timeRelayPanicinteger · int32Opcional
timeRelayConciergeWakeUpNotAnsweredinteger · int32Opcional
Respostas
chevron-right
200

Quando o reinício ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/resets

24. Atualizar Configurações de Tempo de Reset (por ID)

Descrição:

Ajusta os temporizadores internos de um controlador, como o tempo de acionamento de porta, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/resets

Quando Usar:

  • Para aplicar um tempo de abertura de porta padrão a todos os controladores de um condomínio.

  • Para ajustar remotamente o tempo de rearme de um sensor em um dispositivo específico.

Atualizar configurações de Tempo de Reset do controlador de acesso MG3000

post

Atualizar configurações de Tempo de Reset do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
timeRelayPanicinteger · int32Opcional
timeRelayConciergeWakeUpNotAnsweredinteger · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/resets

25. Atualizar Configurações de Protocolo de Tempo (NTP) (por instância)

Descrição:

Configura o cliente NTP de um controlador para sincronização de relógio. Utiliza o ID da instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced/timeProtocols

Quando Usar:

  • Para definir um servidor NTP padrão para todos os dispositivos gerenciados, garantindo a consistência dos logs.

  • Para atualizar o endereço do servidor NTP em caso de mudança na infraestrutura de rede.

Atualizar configurações NTP do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações NTP do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
hourinteger · int32Opcional
minuteinteger · int32Opcional
Respostas
chevron-right
200

Quando o reinício ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced/timeProtocols

26. Atualizar Configurações de Protocolo de Tempo (NTP) (por ID)

Descrição:

Configura o cliente NTP de um controlador para sincronização de relógio, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced/timeProtocols

Quando Usar:

  • Para definir um servidor NTP padrão para todos os dispositivos gerenciados, garantindo a consistência dos logs.

  • Para atualizar o endereço do servidor NTP em caso de mudança na infraestrutura de rede.

Atualizar configurações NTP do controlador de acesso MG3000

post

Atualizar configurações NTP do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
hourinteger · int32Opcional
minuteinteger · int32Opcional
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced/timeProtocols

27. Atualizar Configurações Avançadas (Geral) (por Instância)

Descrição:

Envia e aplica um conjunto completo de configurações avançadas ao controlador em uma única requisição. Este endpoint agrega múltiplos grupos de configurações.

  • POST /api/v1/accessControllers/instances/{id}/settings/advanced

Quando Usar:

  • Para restaurar um conjunto completo de configurações avançadas a partir de um backup.

  • Para provisionar um novo dispositivo com um perfil de configuração complexo e predefinido de uma só vez.

Atualizar configurações do controlador de acesso MG3000 por Instância conectada

post

Atualizar configurações do controlador de acesso MG3000 por Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
Respostas
chevron-right
200

Quando o reinício ocorrer com sucesso

application/json
post
/api/v1/accessControllers/instances/{id}/settings/advanced

28. Atualizar Configurações Avançadas (Geral) (por ID)

Descrição:

Envia e aplica um conjunto completo de configurações avançadas a um controlador em uma única requisição, utilizando seu ID de registro.

  • POST /api/v1/accessControllers/{id}/settings/advanced

Quando Usar:

  • Para clonar a configuração de um dispositivo para outro de forma rápida e completa.

  • Para aplicar um template de configuração complexo a um dispositivo recém-cadastrado no sistema.

Atualizar configurações do controlador de acesso MG3000

post

Atualizar configurações do controlador de acesso MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Corpo
Respostas
chevron-right
200

Quando ocorrer com sucesso

application/json
post
/api/v1/accessControllers/{id}/settings/advanced

29. Restaurar Padrões de Fábrica (por Instância)

Descrição:

Envia um comando para formatar o controlador de acesso MG3000, restaurando todas as suas configurações, cadastros e logs para os padrões originais de fábrica. A operação é irreversível e utiliza o ID de uma instância de conexão ativa.

  • POST /api/v1/accessControllers/instances/{id}/defaults

Quando Usar:

  • Para limpar completamente um dispositivo antes de reutilizá-lo em um novo local ou para solucionar problemas graves de software que não foram resolvidos de outra forma.

  • Para garantir que um dispositivo esteja em seu estado original "de fábrica" antes de uma nova configuração completa.

Formatar MG3000, restaura os padrões de fábrica da Instância conectada

post

Formatar MG3000, restaura os padrões de fábrica da Instância conectada

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int32Obrigatório

Id da instância da conexão

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
post
/api/v1/accessControllers/instances/{id}/defaults

30. Restaurar Padrões de Fábrica (por ID)

Descrição:

Dispara um comando de formatação para restaurar um controlador aos padrões de fábrica, utilizando o ID do dispositivo registrado no sistema. Esta ação apaga todos os dados do equipamento.

  • POST /api/v1/accessControllers/{id}/defaults

Quando Usar:

  • Para permitir que um administrador execute uma restauração de fábrica remotamente a partir de um painel de gerenciamento central, sem precisar de uma conexão direta.

  • Como último recurso para recuperar um dispositivo que se tornou inacessível ou está se comportando de maneira inesperada na rede.

Formatar MG3000

post

Formatar MG3000, restaura os padrões de fábrica

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota
idinteger · int64Obrigatório

Id do controlador de acesso

Parâmetros de consulta
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
post
/api/v1/accessControllers/{id}/defaults

Atualizado