Acionamento Remoto de Relé

Esta seção contém os comandos responsáveis por acionar remotamente as saídas de relé do controlador MG3000. Essa funcionalidade é a base para a abertura de portas, portões e cancelas via software. Os endpoints oferecem métodos de acionamento tanto para a arquitetura padrão quanto para sistemas legados, permitindo a integração com diferentes versões de hardware e firmware.

_{1. Acionar Saída (Relé) (por Instância)}

_Descrição:

Envia um comando para acionar uma saída específica (relé) do controlador de acesso, como abrir uma porta ou portão. A operação utiliza o ID de uma instância de conexão ativa.

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

_{Quando Usar:}

• Para implementar uma função de "abertura remota" em uma aplicação de portaria ou monitoramento, permitindo que um operador libere o acesso.

• Para testar o funcionamento de uma saída específica (relé) durante a instalação ou manutenção do equipamento.

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000 por Instância conectada

post

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000 por Instância conectada.

• Multifunção 4A versão 2.004y ou superior

• Receptor TX-4A versão 3.000q / 2.000z ou superior

• Receptor CTW-4A versão 4.001k / 1.002p ou superior

Autorizações

BearerApiKey

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

application/jsontext/jsonapplication/*+json

deviceTypestring · enumOpcionalValores possíveis:

deviceNumberinteger · int32Opcional

relayinteger · int32Opcional

generateEventbooleanOpcional

timeinteger · int32Opcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/accessControllers/instances/{id}/outputs

HTTPcURLJavaScriptPython

POST /api/v1/accessControllers/instances/{id}/outputs HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "deviceType": "RF",
  "deviceNumber": 1,
  "relay": 1,
  "generateEvent": true,
  "time": 1
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": true
}

_{2. Acionar Saída (Relé) (por ID)}

_Descrição:

Envia um comando para acionar uma saída (relé) de um controlador, utilizando o ID do dispositivo registrado no sistema.

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

_{Quando Usar:}

• Para permitir que um sistema de gerenciamento central ou um aplicativo móvel abra uma porta sem depender de uma conexão de instância ativa.

• Para integrar o acionamento de portas com outros sistemas automatizados (ex: liberar acesso após um pagamento ser confirmado).

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000

post

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000.

• Multifunção 4A versão 2.004y ou superior

• Receptor TX-4A versão 3.000q / 2.000z ou superior

• Receptor CTW-4A versão 4.001k / 1.002p ou superior

Autorizações

BearerApiKey

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 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

application/jsontext/jsonapplication/*+json

deviceTypestring · enumOpcionalValores possíveis:

deviceNumberinteger · int32Opcional

relayinteger · int32Opcional

generateEventbooleanOpcional

timeinteger · int32Opcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/accessControllers/{id}/outputs

HTTPcURLJavaScriptPython

POST /api/v1/accessControllers/{id}/outputs HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "deviceType": "RF",
  "deviceNumber": 1,
  "relay": 1,
  "generateEvent": true,
  "time": 1
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": true
}

_{3. Acionar Saída Legada (Relé) (por Instância)}

_Descrição:

Realiza o acionamento de uma saída (relé) utilizando um método compatível com hardware ou firmwares legados. Utiliza o ID da instância de conexão ativa.

• POST /api/v1/accessControllers/instances/{id}/outputs/legacies

_{Quando Usar:}

• Quando o acionamento padrão (/outputs) não funcionar corretamente em equipamentos mais antigos.

• Para garantir a compatibilidade em ambientes com um mix de versões de firmware do controlador MG3000.

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000 por Instância conectada

post

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000 por Instância conectada

Autorizações

BearerApiKey

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

application/jsontext/jsonapplication/*+json

deviceTypestring · enumOpcionalValores possíveis:

deviceNumberinteger · int32Opcional

relayinteger · int32Opcional

generateEventbooleanOpcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/accessControllers/instances/{id}/outputs/legacies

HTTPcURLJavaScriptPython

POST /api/v1/accessControllers/instances/{id}/outputs/legacies HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "deviceType": "RF",
  "deviceNumber": 1,
  "relay": 1,
  "generateEvent": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": true
}

_{4. Acionar Saída Legada (Relé) (por ID)}

_Descrição:

Realiza o acionamento de uma saída (relé) utilizando um método legado, identificando o controlador pelo seu ID de registro no sistema.

• POST /api/v1/accessControllers/{id}/outputs/legacies

_{Quando Usar:}

• Para acionar remotamente as saídas de controladores mais antigos a partir de um sistema central.

• Em rotinas de backend que precisam garantir a execução de comandos em toda a base de dispositivos, incluindo os legados.

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000

post

Acionar saída (Relés dos Receptores) no controlador de acesso MG3000

Autorizações

BearerApiKey

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 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

application/jsontext/jsonapplication/*+json

deviceTypestring · enumOpcionalValores possíveis:

deviceNumberinteger · int32Opcional

relayinteger · int32Opcional

generateEventbooleanOpcional

Respostas

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/accessControllers/{id}/outputs/legacies

HTTPcURLJavaScriptPython

POST /api/v1/accessControllers/{id}/outputs/legacies HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "deviceType": "RF",
  "deviceNumber": 1,
  "relay": 1,
  "generateEvent": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": true
}