CRUD e Gerenciamento

Esta seção descreve as operações básicas de criação, leitura, atualização e exclusão (CRUD) dos leitores de biometria facial. Esses comandos são utilizados para registrar novos dispositivos, atualizar suas configurações ou consultar/excluir dispositivos existentes.

_{1. Obter Leitores de Biometria Facial por Filtro}

_Descrição:

Retorna uma lista de leitores cadastrados, com possibilidade de aplicar filtros (parâmetros de consulta) para refinar a busca.

GET /api/v1/facialRecognitions

_{Quando Usar:}

Para visualizar todos os leitores ativos ou inativos no sistema;
Para buscas com filtros como status, nome ou IP.

Obter leitores de biometria facial por filtro

get

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 consulta

UserNamestringOpcional

IpAddressstringOpcional

DescriptionstringOpcional

EquipmentstringOpcional

ModelstringOpcional

LocalstringOpcional

StartDatestring · date-timeOpcional

EndDatestring · date-timeOpcional

PageSizeinteger · int32ObrigatórioDefault: 10

PageNumberinteger · int32ObrigatórioDefault: 1

EnabledbooleanOpcionalDefault: true

SortOrderstringOpcionalDefault: asc

SortFieldstringObrigatórioDefault: id

ValuestringOpcional

cultureNamestringOpcional

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

Default: en-US

Respostas

200

application/json

get

/api/v1/facialRecognitions

GET /api/v1/facialRecognitions?PageSize=10&PageNumber=1&SortField=id HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "success": true,
  "failure": true,
  "data": {
    "data": [
      {
        "id": 1,
        "isEnabled": true,
        "userName": "text",
        "equipment": {
          "id": 1,
          "isEnabled": true,
          "ipAddress": "text",
          "port": 1,
          "passcode": "text",
          "description": "text",
          "createdAt": "2026-01-20T17:29:17.920Z",
          "instance": 1,
          "model": "text",
          "local": "text",
          "equipment": "text"
        }
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

_{2. Criar Novo Leitor de Biometria Facial}

_Descrição:

Cadastra um novo leitor de biometria facial no sistema, registrando suas informações básicas e configurando-o para uso.

POST /api/v1/facialRecognitions

_{Quando Usar:}

Ao adicionar um novo dispositivo de biometria facial à infraestrutura de segurança.
Para provisionar leitores em lote ou automatizar o processo de registro de novos equipamentos.

Cria novo leitor de biometria facial

post

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 consulta

cultureNamestringOpcional

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

Default: en-US

Corpo

ipAddressstring | nuloOpcional

portinteger · int32Opcional

descriptionstring | nuloOpcional

modelstring | nuloOpcional

localstring | nuloOpcional

equipmentstring | nuloOpcional

userNamestring | nuloOpcional

passwordstring | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

post

/api/v1/facialRecognitions

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

{
  "ipAddress": "text",
  "port": 1,
  "description": "text",
  "model": "text",
  "local": "text",
  "equipment": "text",
  "userName": "text",
  "password": "text"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "userName": "text",
    "equipment": {
      "id": 1,
      "isEnabled": true,
      "ipAddress": "text",
      "port": 1,
      "passcode": "text",
      "description": "text",
      "createdAt": "2026-01-20T17:29:17.920Z",
      "instance": 1,
      "model": "text",
      "local": "text",
      "equipment": "text"
    }
  }
}

3. Obter Leitor de Biometria Facial (por ID)

Descrição:

Busca os dados detalhados de um leitor específico com base no seu identificador único (ID).

GET /api/v1/facialRecognitions/{id}

Quando Usar:

Para visualizar ou auditar as configurações atuais de um leitor já cadastrado;
Para facilitar atualizações específicas.

Obter leitor de biometria facial pelo Id

get

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

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

application/json

get

/api/v1/facialRecognitions/{id}

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

200

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "userName": "text",
    "equipment": {
      "id": 1,
      "isEnabled": true,
      "ipAddress": "text",
      "port": 1,
      "passcode": "text",
      "description": "text",
      "createdAt": "2026-01-20T17:29:17.920Z",
      "instance": 1,
      "model": "text",
      "local": "text",
      "equipment": "text"
    }
  }
}

4. Atualizar Leitor de Biometria Facial

Descrição:

Permite a edição das informações do leitor facial, como nome, IP ou configurações de integração.

PUT /api/v1/facialRecognitions/{id}

Quando Usar:

Ao alterar a rede do leitor, nome de identificação ou outros atributos relevantes;
Em ajustes técnicos após testes ou migrações.

Atualiza leitor de biometria facial

put

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

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

portinteger · int32Opcional

descriptionstring | nuloOpcional

modelstring | nuloOpcional

localstring | nuloOpcional

equipmentstring | nuloOpcional

userNamestring | nuloOpcional

passwordstring | nuloOpcional

Respostas

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/facialRecognitions/{id}

PUT /api/v1/facialRecognitions/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "ipAddress": "text",
  "port": 1,
  "description": "text",
  "model": "text",
  "local": "text",
  "equipment": "text",
  "userName": "text",
  "password": "text"
}

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "userName": "text",
    "equipment": {
      "id": 1,
      "isEnabled": true,
      "ipAddress": "text",
      "port": 1,
      "passcode": "text",
      "description": "text",
      "createdAt": "2026-01-20T17:29:17.920Z",
      "instance": 1,
      "model": "text",
      "local": "text",
      "equipment": "text"
    }
  }
}

5. Desabilitar Leitor de Biometria Facial

Descrição:

Desativa logicamente o leitor facial no sistema, mantendo o histórico de dados, mas bloqueando o uso do equipamento.

DELETE /api/v1/facialRecognitions/{id}

Quando Usar:

Em caso de substituição, manutenção prolongada ou desativação definitiva do equipamento;
Para controle de inventário e segurança.

Desabilita leitor de biometria facial

delete

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

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

application/json

400

Bad Request

application/json

delete

/api/v1/facialRecognitions/{id}

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

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

6. Reiniciar Biometria Facial (por Instância)

Descrição:

Envia um comando para reiniciar o leitor de biometria facial, forçando um reboot do dispositivo, utilizando o ID de uma instância de conexão ativa.

POST /api/v1/facialRecognitions/instances/{id}/restarts

Quando Usar:

Para solucionar problemas de funcionamento do leitor que podem ser resolvidos com um reinício.
Para aplicar configurações que exigem um reboot do dispositivo para entrar em vigor.

Reiniciar biometria facial por Instância conectada

post

Reiniciar biometria facial 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 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 ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

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

POST /api/v1/facialRecognitions/instances/{id}/restarts 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"
    }
  }
}

7. Reiniciar Biometria Facial (por ID)

Descrição:

Envia um comando para reiniciar o leitor de biometria facial, forçando um reboot do dispositivo, utilizando o ID do dispositivo registrado no sistema.

POST /api/v1/facialRecognitions/{id}/restarts

Quando Usar:

Para reiniciar um leitor de biometria facial remotamente a partir de um painel de gerenciamento central.
Para incluir o reinício em rotinas de manutenção agendadas para múltiplos dispositivos.

Reiniciar biometria facial

post

Reiniciar biometria facial

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

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/facialRecognitions/{id}/restarts

POST /api/v1/facialRecognitions/{id}/restarts 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"
    }
  }
}

AnteriorControladores Faciais PróximoConexão

Atualizado há 3 meses

hashtag1. Obter Leitores de Biometria Facial por Filtro

hashtagDescrição:

hashtagQuando Usar:

hashtagObter leitores de biometria facial por filtro

hashtag2. Criar Novo Leitor de Biometria Facial

hashtagDescrição:

hashtagQuando Usar:

hashtagCria novo leitor de biometria facial

hashtag3. Obter Leitor de Biometria Facial (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter leitor de biometria facial pelo Id

hashtag4. Atualizar Leitor de Biometria Facial

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualiza leitor de biometria facial

hashtag5. Desabilitar Leitor de Biometria Facial

hashtagDescrição:

hashtagQuando Usar:

hashtagDesabilita leitor de biometria facial

hashtag 6. Reiniciar Biometria Facial (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagReiniciar biometria facial por Instância conectada

hashtag 7. Reiniciar Biometria Facial (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagReiniciar biometria facial

_{1. Obter Leitores de Biometria Facial por Filtro}

_Descrição:

_{Quando Usar:}

Obter leitores de biometria facial por filtro

_{2. Criar Novo Leitor de Biometria Facial}

_Descrição:

_{Quando Usar:}

Cria novo leitor de biometria facial

3. Obter Leitor de Biometria Facial (por ID)

Descrição:

Quando Usar:

Obter leitor de biometria facial pelo Id

4. Atualizar Leitor de Biometria Facial

Descrição:

Quando Usar:

Atualiza leitor de biometria facial

5. Desabilitar Leitor de Biometria Facial

Descrição:

Quando Usar:

Desabilita leitor de biometria facial

6. Reiniciar Biometria Facial (por Instância)

Descrição:

Quando Usar:

Reiniciar biometria facial por Instância conectada

7. Reiniciar Biometria Facial (por ID)

Descrição:

Quando Usar:

Reiniciar biometria facial