As APIs biométricas (Interfaces de Programação de Aplicativos) possibilitam a autenticação e a autorização segura de diferentes tipos de aplicativos. Elas coordenam as solicitações de verificação biométrica e oferecem uma experiência eficiente ao oferecer suporte a vários tipos de autenticação de indivíduos, como impressão digital e biometria facial.
O passo a passo descrito aqui mostra como testar algumas das operações básicas de gerenciamento de registros, também conhecido como CRUD de uma API biométrica.
O que é CRUD
CRUD é a sigla para criar, ler, atualizar e excluir. Essas são as quatro operações principais que geralmente podem ser tratadas em um banco de dados.
Em resumo, o CRUD é um conjunto de operações formado por solicitações básicas que um aplicativo faz a um banco de dados.
Agora que você sabe o que é CRUD, entenda em 4 etapas como testar operações básicas e como elas funcionam em uma API biométrica por meio do Postman.
1. Inscreva a biometria na API biométrica
A primeira operação CRUD está relacionada à criação. A criação se refere ao registro de um indivíduo no banco de dados.
Esse procedimento foi desenvolvido em outro tutorial intitulado: Como registrar a biometria facial de um indivíduo com o Postman.
O artigo vai mostrar o passo a passo para registrar um usuário em apenas 6 etapas.
Além disso, o conteúdo vai desde a criação da conta para receber a chave de acesso da API até adicionar uma pessoa e sua foto facial à plataforma biométrica do Postman.
2. Verifique a biometria na API biométrica
Depois que a primeira operação for concluída, você poderá iniciar a verificação.
A função permite verificar se os dados biométricos fornecidos na solicitação pertencem realmente a um indivíduo previamente cadastrado no sistema, tanto para impressões digitais quanto para rosto.
Nessa comparação, você deve incluir pelo menos uma imagem facial, pois na fase de registro usamos um rosto. Caso contrário, uma mensagem de erro de formato JSON inválido será retornada e o procedimento não será concluído com êxito.
Inicie a verificação pelo cabeçalho de autorização que deve ser preenchido de acordo com etapa 3 do tutorial de registro. Nessa ocasião, basta alterar o final do URL para verificar: https://api.biopassid.com/multibiometrics/verify.
Os parâmetros no corpo da solicitação de verificação são semelhantes aos do registro. Então, também podemos seguir etapa 4 do tutorial de registro alterando somente o conteúdo da variável Face-1, que é a imagem transformada em base64.
Para converter a imagem que será usada como comparação, você só precisa convertê-la em base64 para que ela se torne uma sequência de caracteres legível por computador.
Saiba mais no artigo: Como registrar a biometria facial de um usuário via Postman.
Se a solicitação for bem-sucedida, você receberá o objeto Person como resposta com os seguintes campos:
- ID personalizada: uma string com o identificador do indivíduo registrado.
- Partida: um booleano que indica se a biometria corresponde à da pessoa indicada.
- Detalhes da partida: um objeto que detalha a comparação entre a biometria que tem os parâmetros FaceMatched e NonMatchedFingers.
- Sucesso: um booleano que determina o sucesso da transação.
Em caso de falha, você receberá o status '400 Solicitação inválida'. No corpo da resposta, a mensagem indicará o motivo presumido. No exemplo abaixo, o motivo foi que a pessoa a ser verificada não existia no banco de dados consultado, retornando o erro “Pessoa não encontrada”:
Para ver todos os erros e descrições, verifique o Documentação da API BioPass ID.
Com essa etapa concluída, continue com a atualização.
3. Atualize os dados na API biométrica
Para editar os dados de uma pessoa, use o método PUT e o URL https://api.biopassid.com/multibiometrics/update.
Nesse ponto, altere exatamente o que você deseja nos parâmetros do corpo da solicitação. A sintaxe será a mesma das operações anteriores.
Na transação, é essencial que pelo menos uma impressão digital ou imagem facial seja inserida no corpo da solicitação. Caso contrário, a API retornará a mensagem de erro Formato JSON inválido.
Como no registro, a resposta bem-sucedida mostrará um objeto Pessoa com os campos:
- ID do cliente.
- ID personalizada.
- ID do BioPass.
Em caso de falhas ou dúvidas sobre a mensagem de resposta, verifique os detalhes na documentação. E se o erro persistir, entre em contato com o suporte da API BioPass ID para obter ajuda.
4. Excluir uma biometria na API biométrica
Excluir uma biometria na API é a transação mais simples. Não é necessário preencher os campos Dedos ou Rosto.
Para excluir uma pessoa da plataforma biométrica, use o DELETAR método e o url https://api.biopassid.com/multibiometrics/delete. No corpo da solicitação, você só precisa informar o identificador da pessoa física cadastrada.
Se a solicitação for bem-sucedida, você receberá o status “200 OK” e no corpo da resposta haverá um objeto Person com o campo nulo CustomID, como na imagem abaixo:
Algumas falhas podem acontecer nessa operação, como:
- Formato JSON inválido.
- Não é possível conectar-se ao banco de dados.
- Pessoa não encontrada.
A captura de tela a seguir ilustra uma solicitação malsucedida na qual o identificador inserido no sistema não pôde ser encontrado.
5. Aplique você mesmo ao Postman
Você aprendeu neste artigo sobre o que é CRUD e como usar seus recursos quando se trata de uma plataforma biométrica.
Também expliquei de forma passo a passo como testar operações básicas em uma API biométrica via Postman, como registrar, verificar, atualizar e excluir uma biometria.
Agora, não deixe de testar as várias outras operações do Pacote multibiométrico no BioPass ID e até o próximo tutorial.
