API que se comunica com um dispositivo biométrico local nitgen, perfeito para integração com aplicações web.
- Requer que as bibliotecas do SDK eNBioBSP estejam instaladas no sistema.
- .NET 7 ou superior
- Se você deseja apenas consumir a API, não é necessário compilar o projeto; basta baixar a versão mais recente da API na página de Lançamentos/Releases, executar o instalador e executar a API localmente
O prefixo é: http://localhost:5000/apiservice/
Você pode alterar a porta em appsettings.json se precisar em caso de conflito.
Ativa o dispositivo biométrico para capturar sua impressão digital, caso tudo corra bem imagens da captura atual são salvas localmente no diretório %temp%/fingers-registered e é retornado:
200 | OK
{
"fingers-registered": 1,
"template": "AAAAAZCXZDSfe34t4f//...", <------- fingerprint hash
"fingers-id": [ 1, 6 ], <------- 1 to 5 - right thumb to right pinky: 6 to 10 - left thumb to left pinky
"quality-FIR": 100, <------- quality value of the fingerprint data with a scale of 0 to 100
"success": true
}qualquer outra coisa:
400 | BAD REQUEST
{
"message": "Error on Capture: {nitgen error code}",
"success": false
}Você pode passar um parâmetro opcional img para retornar a imagem da digital. As opções disponíveis são:
false: Retorno padrão, sem a imagem.true: Retorna a imagem em base64.
Exemplo de uso e retorno:
/capture-hash?img=true
200 | OK
{
"fingers-registered": 1,
"template": "AAAAAZCXZDSfe34t4f//...", <------- fingerprint hash
"fingers-id": [ 1, 2 ], <------- 1 to 5 - right thumb to right pinky: 6 to 10 - left thumb to left pinky
"images": ["base64string1", "base64string2", "..."], <------- array of base64 encoded images (1 to 5 - right thumb to right pinky: 6 to 10 - left thumb to left pinky)
"quality-FIR": 100, <------- quality value of the fingerprint data with a scale of 0 to 100
"success": true
}Ativa o dispositivo biométrico para capturar sua impressão digital para verificação, caso tudo corra bem, retorna:
200 | OK
{
"template": "AAAAAZCXZDSfe34t4f//...", <------- fingerprint hash
"image": "base64", <------- fingerprint image
"success": true
}qualquer outra coisa:
400 | BAD REQUEST
{
"message": "Error on Capture: {nitgen error code}",
"success": false
}Você pode passar um parâmetro opcional window para definir o estilo da janela de captura. As opções disponíveis são:
0(POPUP): Janela de captura padrão.1(INVISIBLE): Captura invisível.65536(NO_FPIMG): Sem imagem de impressão digital.131072(TOPMOST): Janela sempre no topo.262144(NO_WELCOME): Sem mensagem de boas-vindas.524288(NO_TOPMOST): Janela não fica no topo.
Exemplo de uso:
/capture-for-verify?window=1
Recebe um template e ativa o dispositivo biométrico para comparar:
{
"template": "AAAAAZCXZDSfe34t4f//..."
}caso o procedimento de verificação corra bem, retorna:
200 | OK
{
"message": "Fingerprint matches / Fingerprint doesnt match",
"success": true/false
}qualquer outra coisa:
400 | BAD REQUEST
{
"message": "Timeout / Error on Verify: {nitgen error code}",
"success": false
}Você pode passar um parâmetro opcional img para retornar a imagem da digital. As opções disponíveis são:
false: Retorno padrão, sem a imagem.true: Retorna a imagem em base64.
Exemplo de uso e retorno:
/match-one-on-one?img=true
200 | OK
{
"message": "Fingerprint matches / Fingerprint doesnt match",
"image": "base64", <------- fingerprint image
"success": true/false
}Captura sua impressão digital e faz uma busca no índice (1:N) a partir do banco de dados em memória, caso tudo corra bem:
200 | OK
{
"message": "Fingerprint match found / Fingerprint match not found",
"id": id_number, <------ returns 0 in case its not found
"success": true/false
}qualquer outra coisa:
400 | BAD REQUEST
{
"message": "Error on Capture: {nitgen error code}",
"success": false
}Caso encontre problemas com a validação da impressão digital sendo muito rigorosa ou muito permissível, é possível passar um parâmetro opcional secuLevel para reduzir ou aumentar o nível de segurança da validação entre 1 (mínimo) e 9 (máximo), o padrão é 5.
/identification?secuLevel=9
Recebe um array de templates com ID para carregar na memória do index search:
[
{
"id": id_number, <------ e.g: 1, 2, 3 or 4235, 654646, 23423
"template": "AAAAAZCXZDSfe34t4f//..."
},
{
"id": id_number,
"template": "AAAAAZCXZDSfe3ff454t4f//..."
},
...
]caso o procedimento de verificação corra bem, retorna:
200 | OK
{
"message": "Templates loaded to memory",
"success": true
}qualquer outra coisa:
400 | BAD REQUEST
{
"message": "Error on AddFIR: {nitgen error code}",
"success": false
}Exclui todos os dados armazenados na memória para uso no index search, caso tudo corra bem, retorna:
200 | OK
{
"message": "All templates deleted from memory",
"success": true
}Retorna a quantidade de templates armazenados na memória:
200 | OK
{
"total": 0, <------ total templates
"success": true
}Retorna o ID único do dispositivo biométrico:
200 | OK
{
"serial": "FF-FF-FF-FF-FF-FF-FF-FF", <------ device ID
"success": true
}Recebe dois ou mais templates e retorna um template único com a informação de todos os dedos registrados:
[
{
"template": "AAAAAZCXZDSfe34t4f//..."
},
{
"template": "AAAAAZCXZDSfe3ff454t4f//..."
},
...
]caso o procedimento de verificação corra bem, retorna:
200 | OK
{
"template": "AAAAAZCXZDSfe34t4f//...", <------ combined hash
"message": "Templates joined successfully",
"success": true
}qualquer outra coisa:
400 | BAD REQUEST
{
"message": "Error creating template: {nitgen error code}",
"success": false
}