Acionamento Remoto de Relé

Esta seção apresenta os endpoints responsáveis por acionar remotamente a abertura da porta associada ao leitor de biometria facial. O comando pode ser executado tanto via ID do dispositivo cadastrado quanto por uma instância conectada. Essa funcionalidade é útil em situações em que se deseja liberar o acesso remotamente, como em guaritas ou centrais de monitoramento.

1. Abertura Remota (por Instância)

Descrição:

Realiza a abertura remota da porta associada ao leitor facial conectado via instância ativa de comunicação.

• POST /api/v1/facialRecognitions/instances/{id}/remoteOpenings

Quando Usar:

• Quando ainda não há cadastro do dispositivo, mas ele está conectado em tempo real;

• Em ações emergenciais realizadas durante o processo de instalação ou testes de conexão;

• Para liberações temporárias via sessão de gerenciamento ativa.

Abertura remota do leitor de biometria facial por Instância conectada

post

Abertura remota do leitor de biometria facial 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 conectada

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

201

Quando a abertura for ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/instances/{id}/remoteOpenings

HTTPcURLJavaScriptPython

POST /api/v1/facialRecognitions/instances/{id}/remoteOpenings HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": "text"
    }
  }
}

---

2. Abertura Remota (por ID)

Descrição:

Realiza a abertura remota da porta vinculada ao leitor de biometria facial utilizando seu identificador único (ID).

• POST /api/v1/facialRecognitions/{id}/remoteOpenings

Quando Usar:

• Para liberar o acesso de forma manual e remota a partir de sistemas ou centrais de controle;

• Em situações de contingência, como problemas de leitura biométrica ou de cartão;

• Para simular o acionamento de dispositivos durante testes ou manutenções.

Abertura remota de porta através do leitor de biometria facial

post

Abertura remota de porta através do leitor de biometria facial

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 · int64Obrigatório

Id do leitor de biometria facial

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

201

Quando a abertura for ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/{id}/remoteOpenings

HTTPcURLJavaScriptPython

POST /api/v1/facialRecognitions/{id}/remoteOpenings HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": {
    "response": {
      "responseURL": "text",
      "createdID": 1,
      "responseCode": 1,
      "subResponseCode": 1,
      "responseString": "text",
      "statusCode": 1,
      "statusString": "text",
      "data": "text"
    }
  }
}