Conexão

Esta seção contempla os endpoints responsáveis por iniciar a comunicação entre o sistema e os leitores de biometria facial. A conexão é necessária para que comandos em tempo real possam ser enviados e recebidos, como sincronização de data/hora e abertura remota de portas.

1. Conectar o Leitor de Biometria Facial

Descrição:

Inicia a conexão com o leitor de biometria facial a partir de parâmetros informados no corpo da requisição (ex.: IP, porta, senha de comunicação etc.).

• POST /api/v1/facialRecognitions/connections

Quando Usar:

• Quando se deseja conectar a um leitor sem utilizar seu ID previamente cadastrado;

• Para testes iniciais ou integração de leitores recém-instalados.

Conectar o leitor de biometria facial

post

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

ipstring | nuloOpcional

portinteger · int32Opcional

usernamestring | nuloOpcional

passwordstring | nuloOpcional

Respostas

201

Quando a conexão ocorrer com sucesso

application/json

400

Quando ocorrer erro ao conectar

application/json

post

/api/v1/facialRecognitions/connections

HTTPcURLJavaScriptPython

POST /api/v1/facialRecognitions/connections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "ip": "text",
  "port": 1,
  "username": "text",
  "password": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "ip": "text",
    "port": 1,
    "id": 1,
    "username": "text",
    "password": "text",
    "instance": 1
  }
}

---

2. Conectar o Leitor de Biometria Facial (por ID)

Descrição:

Estabelece uma conexão com o leitor facial já cadastrado no sistema, utilizando seu identificador exclusivo (ID).

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

Quando Usar:

• Ao conectar um equipamento que já consta no banco de dados;

• Quando se deseja realizar comandos em tempo real, como sincronizações, com um leitor previamente configurado.

Conectar o leitor de biometria facial por Id

post

Conectar o leitor de biometria facial por Id

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 conexão ocorrer com sucesso

application/json

400

Quando ocorrer erro ao conectar

application/json

post

/api/v1/facialRecognitions/{id}/connections

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "failure": true,
  "data": {
    "ip": "text",
    "port": 1,
    "id": 1,
    "username": "text",
    "password": "text",
    "instance": 1
  }
}

_{3. Exibir Conexões Ativas}

_Descrição:

Retorna uma lista de todas as conexões ativas entre o sistema e os leitores de biometria facial.

• GET /api/v1/facialRecognitions/connections

_{Quando Usar:}

• Para monitorar o status de conectividade de todos os leitores de biometria facial em tempo real.

• Para identificar quais dispositivos estão online e disponíveis para receber comandos.

Exibir as conexões ativas com leitores de biometria facial

get

Exibir as conexões ativas com leitores 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"

Respostas

200

Quando a ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/facialRecognitions/connections

HTTPcURLJavaScriptPython

GET /api/v1/facialRecognitions/connections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": [
    {
      "instance": 1,
      "uId": "123e4567-e89b-12d3-a456-426614174000",
      "ipAddress": "text",
      "port": 1,
      "passcode": "text",
      "description": "text",
      "createdAt": "2026-01-20T17:28:26.013Z",
      "isEnabled": true,
      "id": 1
    }
  ]
}

_{4. Desconectar Leitor (por Instância)}

_Descrição:

Envia um comando para encerrar a conexão ativa com um leitor de biometria facial específico, utilizando o ID da instância de conexão.

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

_{Quando Usar:}

• Para finalizar uma sessão de comunicação com um leitor após a conclusão de operações ou para liberar recursos.

• Para solucionar problemas de conexão, forçando a reconexão do dispositivo.

Desconectar um leitor de biometria facial por Instância conectada

post

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

200

Quando ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "failure": true,
  "data": {
    "ip": "text",
    "port": 1,
    "id": 1,
    "instance": 1,
    "isDisconnected": true
  }
}

_{5. Desconectar Leitor (por ID)}

_Descrição:

Envia um comando para encerrar a conexão com um leitor de biometria facial, utilizando o ID do dispositivo registrado no sistema.

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

_{Quando Usar:}

• Para desconectar um leitor de biometria facial remotamente a partir de um painel de gerenciamento central.

• Para incluir a desconexão em rotinas de manutenção ou desligamento de dispositivos, sem depender de uma instância de conexão ativa.

Desconectar o leitor de biometria facial por Id

post

Desconectar o leitor de biometria facial por Id

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

200

OK

application/json

201

Quando a conexão ocorrer com sucesso

400

Quando ocorrer erro ao conectar

application/json

post

/api/v1/facialRecognitions/{id}/disconnections

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "failure": true,
  "data": {
    "ip": "text",
    "port": 1,
    "id": 1,
    "instance": 1,
    "isDisconnected": true
  }
}