As APIs biométricas (Application Programming Interface) permitem autenticar e autorizar vários tipos de aplicações de forma segura. Eles coordenam um prompt de verificação biométrica e fornecem uma grande experiência, suportando múltiplos tipos de autenticação de indivíduos, tais como impressão digital e biometria facial.
O passo a passo aqui descrito mostra como testar algumas das operações básicas de gerenciamento de registros, também conhecidas como CRUD de uma API Biométrica.
O que é CRUD?
CRUD é o acrônimo de Create, Read, Update and Delete. Estas são as quatro operações principais que normalmente podem ser tratadas em um banco de dados.
Em resumo, CRUD é um conjunto de operações formado por solicitações básicas que um aplicativo faz a um banco de dados.
Agora que você entende o que é CRUD, entenda em 4 passos como testar operações básicas e como elas funcionam em uma API biométrica através do Postman.
1. Cadastre a biometria na API Biométrica
A primeira operação CRUD está relacionada à criação. A criação refere-se ao registro de um indivíduo no banco de dados.
Este procedimento foi desenvolvido em outro tutorial intitulado: Como registrar a biometria facial de um indivíduo com o Postman.
O artigo mostrará um passo a passo simples de cadastro de 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é a adição de uma pessoa e sua foto facial à plataforma biométrica pelo Postman.
2. Verifique a biometria na API Biométrica
Uma vez concluída a primeira operação, você pode iniciar a verificação.
A função permite verificar se os dados biométricos fornecidos no pedido pertencem realmente a um indivíduo previamente registrado no sistema, tanto para impressões digitais como para o rosto.
Nesta comparação você deve incluir pelo menos uma imagem facial, já que na fase de registro usamos um rosto. Caso contrário, uma mensagem de erro no formato JSON inválido será devolvida e o procedimento não será concluído com sucesso.
Comece a verificação pelo cabeçalho de autorização que deve ser preenchido de acordo com o passo 3 do tutorial de registro. Nesta ocasião, basta alterar o final da url para verify: https://api.biopassid.com/multibiometrics/verify.
Os parâmetros no corpo do pedido de verificação parecem semelhantes aos do registro. Portanto, também podemos seguir o passo 4 do tutorial de registro alterando apenas 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 para base64 para que se torne uma seqüência de caracteres legível por computador.
Saiba mais no artigo: Como registrar a biometria facial de um usuário no Postman.
Se a solicitação for bem sucedida, você terá como resposta o objeto Person com os seguintes campos:
- CustomID: uma string com o identificador do indivíduo registrado.
- Match: um booleano que indica se a biometria informada corresponde a da pessoa indicada.
- MatchDetails: um objeto que detalha a comparação entre biometria que tem os parâmetros FaceMatchedFingers e NonMatchedFingers.
- Success: um booleano que determina o sucesso da transação.
Em caso de falha, você receberá o status '400 Bad Request'. 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, devolvendo o erro "Person not found":
Para conhecer todos os erros e descrições, consulte a documentação da API BioPass ID.
Com esta etapa completa, proceder à atualização.
3. Atualize os dados na API Biométrica
Para editar os dados de um indivíduo, use o método PUT e a URL https://api.biopassid.com/multibiometrics/update.
Neste ponto, altere exatamente o que você deseja nos parâmetros do corpo de solicitação. A sintaxe será a mesma que para as operações anteriores.
Na transação, é essencial que pelo menos uma imagem de impressão digital ou 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 de sucesso mostrará um objeto Person com os campos:
- Client ID.
- Custom ID.
- BioPass ID.
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 do BioPass ID para obter ajuda.
4. Delete uma biometria na API biométrica
Deletar uma biometria na API é a transação mais simples. Não requer o preenchimento dos campos de Fingers ou Face.
Para excluir uma pessoa da plataforma biométrica use o método DELETE e a url https://api.biopassid.com/multibiometrics/delete. No corpo da solicitação, basta informar o identificador do indivíduo registrado.
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 nesta operação, como por exemplo:
- Formato JSON inválido.
- Impossibilidade de se conectar com o banco de dados.
- Pessoa não encontrada.
A seguinte captura de tela ilustra uma solicitação mal sucedida na qual o identificador inserido no sistema não pôde ser encontrado.
5. Aplique você mesmo no Postman
Você aprendeu neste artigo sobre o que é CRUD e como usar suas características quando se trata de uma plataforma biométrica.
Também expliquei, passo a passo, como testar operações básicas em uma API biométrica via Postman, tais como cadastrar, verificar, atualizar e excluir uma biometria.
Agora, não deixe de testar as várias outras operações do Multibiometric Package no BioPass ID e nos vemos no próximo tutorial.
Tradução: Thalita Ferreira
