API Biometrias Facial e Digital

Criada por Juan José Gómez, Modificado em Seg, 19 Mai na (o) 2:54 PM por Juan José Gómez

Resumo

Este artículo apresenta a documentação das APIs de IntegraFácil para biometrias facial e digital.

Os métodos relacionados à biometria facial utilizam por padrão, a porta 8080. Já os métodos de biometria digital operam, em geral, sobre a porta 80 (padrão HTTP), podendo esta ser omitida nas requisições.

Nota: No caso específico do cadastro de template digital via API, a porta utilizada também é a 8080.

API Biometria Facial

Cadastro de Template Facial

A imagem contendo a face deve ser no máximo 640x480 ou 480x640

Request:

POST: http://IP_SERVIDOR_LOCAL:8080/v1/face/template

Usando Base64

body
{  
  "personId": "2",
  "jpegImageBase64": "imagem jpeg em base64"
}

Usando URL da foto

body
{  
  "personId": "2",
  "photoUrl": "https://url/foto.jpg"
}

Response:

Status code: 200

{
  "success": true,
  "engine": "engine3",
  "personId": "2",
  "template": "VEHT2bcd1aKIw9R9pHP..0ARPL9AdMBnAoaKKBH/9k=",
  "id": "ad6e5262-3733-4fb7-9278-b58f7c1d62a3",
  "enrollScore": 0,
  "createdAt": "2021-03-10T14:12:07.000Z",
  "updatedAt": "2021-03-10T14:12:07.000Z"
}

Identificar Template Facial

Request:

POST: http://IP_SERVIDOR_LOCAL:8080/v1/face/image/identify

Usando Base64

body
{    
    "personId": "2",
    "jpegImageBase64": "imagem jpeg em base64"
}

Response:

Status code: 200

{
  "sucess": true,
  "msg": "MATCH",
  "engine": "engine3",
  "personId": "2",
  "score": 0.606914222240448,
  "template": "VElGMDEvKCogKCU1O..KD9M9Fs/qHU=",
  "thershold": 0.5,
  "id": "898dee95-712f-4958-9c98-340d93e34f8c"
}

Excluir Template Facial

Request:

DELETE: http://IP_SERVIDOR_LOCAL:8080/v1/face/templates?personId=2

Response:

Status code: 200

Obter Template Facial

Request:

GET: 
http://IP_SERVIDOR_LOCAL:8080/v1/face/template?personId=2

Response:

Status code: 200

{
  "id": "39820510-8304-4aa2-9e98-0fc3654056b0",
  "engine": "engine3",
  "personId": "2",
  "enrollScore": 0,
  "template": "VElGMDEvKCogKCU1O..KD9M9Fs/qHU=",
  "jpegImageBase64": "/9j/4AAQSkZJRgABAQEAYAB..oaKKBH/9k=",
  "createdAt": "2021-03-10T18:03:06.000Z",
  "updatedAt": "2021-03-10T18:03:06.000Z"
}

API Biometria digital

Cadastro de Template Digital

O IntegraFacil2 vai guiar ao usuário por três tentativas de cadastro e uma de verificação

Request:

GET: http://IP_SERVIDOR_CADASTRO/metodos/cadastraDigital?usuarioID=1234&idxDedo=7

Response:

Status code: 200

{
   "sucesso":true,
   "qualidade":10,
   "resultado":"MDczICAgICAgICAgICAgICAgICAgIDIwMDHRBwMDACkSGd3MUAAIOEw...AAAA=",
   "idxDedo":"7"
}

Nota: Para cadastrar diretamente o template biométrico, utilize a API do servidorIF. É essencial que o template utilizado seja o gerado no passo anterior, sem alterações em sua estrutura, para garantir o correto funcionamento do fluxo de acesso

Request:

POST: http://IP_SERVIDOR_LOCAL:8080/v1/finger/template

Usando Template Futronic

body
{    
    "personId": "1234",
    "template": "MyAxMDAgICAg..."
}

Response:

Status code: 200

{
  "sucess": true,
  "id": "bc37c83b-...",
  "personId": "123",
  "fingerIdx": 7,
  "template": "MyAxMDAgICAg..."
}

Listar todas as Digitais cadastradas de um aluno

Request:

GET: http://IP_SERVIDOR_CADASTRO/metodos/listaTemplatesDigital?usuarioID=100

Response:

Status code: 200

{
   "resultado":[
      {
         "usuarioID":"1",
         "idxDedo":6,
         "template":"OCAxMDA...AAAAAAAAAAAAA="
      }
   ]
}

Listar todas as Digitais cadastradas

Request:

GET: http://IP_SERVIDOR_CADASTRO/metodos/listaTemplatesDigital

Response:

Status code: 200

{
   "resultado":[
      {
         "usuarioID":"1",
         "idxDedo":4,
         "template":"OCAxMDAgICAgICAgICAgICAgICAgIDAAAAAAAA="
      },
      {
         "usuarioID":"2",
         "idxDedo":7,
         "template":"MDczICAgICAggICAgIaCgIC....AAAAAAAAAAAA="
      },
      {
         "usuarioID":"3",
         "idxDedo":6,
         "template":"OCAxMDAgICAgICAgICAgICAgICAgIDAAAAAAAA="
      }
   ]
}

Exclusão de uma digital

Request:

GET: http://IP_SERVIDOR_CADASTRO/metodos/excluiDigital?usuarioID=100&idxDedo=3

Response:

Status code: 200

resultado:   "OK"

Exclusão de todas as digitais de um aluno

Request:

GET: http://IP_SERVIDOR_CADASTRO/metodos/excluiTodasDigitais?usuarioID=1234

Response:

Status code: 200

resultado:   "OK"

Página de Processamento

Url onde iremos solcitar autorização de acesso para o usuário. As macros que podem ser enviadas na requisição são:

ns = Número de série do dispositivo

dispositivo = Tipo de dispositivo

info = identificador único do usuário

grupo = grupo do dispositivo

Nota: A url a seguir é apenas um exemplo, a estrutura dela é definida pelo cliente.

Request:

GET: http://seuwebservice/person?usuarioID={{info}}&dispositivo={{dispositivo}}

Response:

Status code: 200

{
      "text": "text to turnstile",
      "entryReleased": false,
      "exitReleased": true,
      "accessTime": 5000,
      "msgToReception": "msg to reception",
      "person": {
           "name": "personName",
           "password": "123456",
           "fingerTemplates":[],
           "photoUrl":"http://foto-url.jpg",
       }
}

Liberação Manual

Request:

POST: http://IP_CATRACA/v1/turnstile/release
{
	"entryReleased": true,
	"exitReleased": true,
	"accessTime": 5000,
	"text": "ACESSO LIBERADO"
}

Response:

Status code: 204