Documentação Técnica

Eduardo Martini

Biometric Reader App

Visão Geral

O Biometric Reader App/ (Insoft Sagem Reader) é uma aplicação desktop desenvolvida em Electron + React que trabalha em conjunto com a API local insoft-sagem-win-api.

O aplicativo é responsável por:

Configurar a comunicação com o leitor biométrico;
Monitorar o status da API e do dispositivo;
Capturar digitais;
Iniciar conversões biométricas;
Exibir informações operacionais em tempo real.

Importante:

O aplicativo não se comunica diretamente com o leitor biométrico.

Toda comunicação é realizada através da API local insoft-sagem-win-api.

Arquitetura

Usuário
    │
    ▼
Biometric Reader App
(Electron + React)
    │
    ▼
insoft-sagem-win-api
    │
    ▼
Leitor Biométrico

Como Funciona

Ao iniciar, o aplicativo:

Carrega as configurações locais;
Verifica se a API está online;
Consulta o status do dispositivo biométrico;
Conecta ao WebSocket para receber atualizações em tempo real;
Disponibiliza as funcionalidades de captura e conversão.

Configuração

O arquivo de configuração principal é:

config/application.json

Exemplo:

{
  "deviceIp": "172.16.110.11",
  "devicePort": 12121,
  "serverIp": "127.0.0.1",
  "serverPort": 8083
}

Campos Principais

Campo	Descrição
deviceIp	IP do leitor biométrico
devicePort	Porta do leitor biométrico
serverIp	Endereço da API local
serverPort	Porta da API local

Comunicação com a API

A API é acessada através da URL:

http://127.0.0.1:8083/insoft-sagem-win-api

Endpoints Disponíveis

Health Check

Verifica se a API está funcionando.

Requisição

GET /insoft-sagem-win-api/v1/health

Resposta Esperada

{
  "name": "insoft-sagem-win-api"
}

Inicializar Dispositivo

Realiza a conexão com o leitor biométrico.

Requisição

POST /insoft-sagem-win-api/v1/device/init

Body (Opcional)

{
  "deviceIp": "172.16.110.11",
  "devicePort": 12121,
  "secure": false
}

Resposta

{
  "success": true
}

Consultar Status do Dispositivo

Retorna o estado atual do leitor biométrico.

Requisição

GET /insoft-sagem-win-api/v1/device/status

Exemplo de Resposta

{
  "connected": true,
  "initialized": true
}

Capturar Digital

Solicita uma captura biométrica diretamente no dispositivo.

Requisição

POST /insoft-sagem-win-api/v1/digital/capturar

Body (Opcional)

{
  "personId": 123
}

Exemplo de Resposta

{
  "success": true,
  "template": "ABCDEF123456",
  "quality": 87
}

Campos Retornados

Campo	Descrição
success	Resultado da operação
template	Template biométrico capturado
quality	Qualidade da captura

Iniciar Conversão Biométrica

Inicia a conversão de imagens para templates biométricos.

Requisição

POST /insoft-sagem-win-api/v1/convert/start

Body

[
  {
    "personId": 1001,
    "image": "<base64>"
  },
  {
    "personId": 1002,
    "image": "<base64>"
  }
]

Campos

Campo	Descrição
personId	Identificador da pessoa
image	Imagem biométrica em Base64

Resposta

{
  "success": true,
  "message": "Conversão iniciada"
}

A conversão ocorre em segundo plano.

O progresso é enviado através do WebSocket.

Comunicação em Tempo Real

O aplicativo utiliza WebSocket para receber atualizações da API.

URL

ws://localhost:5000/ws

Evento de Status

Atualiza as informações do dashboard.

Exemplo

{
  "event": "dashboard:getStatus",
  "data": {
    "errorCount": 0,
    "peopleCount": 10,
    "convertedCount": 8
  }
}

Evento de Início de Conversão

Indica que uma conversão foi iniciada.

Exemplo

{
  "event": "api:convert:start",
  "data": {
    "count": 10
  }
}

Evento de Atualização de Item

Atualiza o resultado de um item durante a conversão.

Exemplo

{
  "event": "api:convert:item",
  "data": {
    "personId": 1001,
    "status": "success"
  }
}

Evento de Finalização

Indica que o processo de conversão foi concluído.

Exemplo

{
  "event": "api:convert:done",
  "data": {
    "results": []
  }
}

Fluxo de Operação

Captura Biométrica

Usuário
    │
    ▼
Aplicativo
    │
    ▼
POST /digital/capturar
    │
    ▼
API
    │
    ▼
Leitor Biométrico
    │
    ▼
Template Biométrico

Conversão Biométrica

Usuário
    │
    ▼
Aplicativo
    │
    ▼
POST /convert/start
    │
    ▼
API
    │
    ▼
Processamento
    │
    ▼
WebSocket
    │
    ▼
Atualização da Interface

Requisitos

Antes de utilizar o sistema, certifique-se de que:

A API está em execução;
O leitor biométrico está conectado;
O IP e a porta do dispositivo estão corretos;
O WebSocket está acessível;
O driver do dispositivo está instalado.

Resumo

O Biometric Reader App é a interface responsável por operar o leitor biométrico através da API local.

As principais funcionalidades são:

Inicializar o dispositivo biométrico;
Consultar o status do equipamento;
Capturar digitais;
Executar conversões biométricas;
Exibir atualizações em tempo real através de WebSocket.

Toda comunicação com o dispositivo é realizada pela API insoft-sagem-win-api.