Confira o passo a passo para cadastrar uma pessoa e sua imagem facial em uma API Biométrica usando o Postman.
Câmeras e sensores de movimento/segurança são cada vez mais comuns em nossa vida diária, presentes em dispositivos móveis, por exemplo. A facilidade de acesso ampliou as possibilidades de utilização de aplicações biométricas que muitas vezes exigem apenas esses dispositivos como forma de autenticação e monitoramento de processos.
Por trás dessa praticidade é necessária a presença de softwares que adotem a biometria
como método de verificação.
A escolha do software a ser utilizado é um desafio recorrente para os desenvolvedores. Afinal, em qual plataforma devo confiar dados tão sensíveis como os coletados pela biometria? Por onde começar a implementar? Como testar?
Entenda agora neste tutorial!
1. Adquira acesso à plataforma de biometria
Para começar, crie uma conta com a API de Biometria para receber uma chave de acesso.
O BioPass ID permite que o cadastro seja realizado sem um método de pagamento,
podendo optar pelo plano gratuito. Esse benefício possibilita testar todos os recursos de
identificação biométrica oferecidos.
Neste tutorial, escolhemos o pacote Multibiometrics como exemplo:
Concluída a inscrição, verifique se o status está ativo na guia "Assinaturas".
2. Crie o projeto
Para uma melhor organização, crie vários projetos com a mesma assinatura. Cada um deles permite criar múltiplas aplicações com uma única chave de acesso cada uma. Desta forma, você pode acompanhar o uso de cada projeto e aplicação de forma independente, bem como controlar os acessos.
Então, vamos lá!
Com o status de assinatura ativo, criar um projeto para acessar a API biométrica.
Clique em "Novo projeto" e preencha os campos obrigatórios. Veja como:
Após criar o projeto, crie uma Aplicação, que será responsável por fornecer a chave de acesso à API. Na aba "Aplicações" do menu lateral, clique em "Nova Aplicação", preencha os campos e escolha o projeto que foi criado na etapa anterior. A nova aplicação aparecerá na tela, como mostrado abaixo:
Depois disso basta clicar no botão com o ícone de chave para visualizar e copiar a chave de acesso à API. Tudo pronto para iniciar!
Aplique com o Postman
Com a chave de acesso passamos para a configuração da requisição no Postman, uma plataforma para a construção e utilização de APIs.
Para iniciar o cadastro, o primeiro passo é enviar a imagem facial de um indivíduo. Todos os detalhes para esta solicitação estão neste tutorial, mas ter a documentação da API à mão é indispensável.
As seguintes etapas foram feitas na versão do Postman instalada na máquina, mas você pode usar a versão do navegador.
3. Autorize a requisição
No cabeçalho da autorização, selecione o tipo para a “API key”. Em seguida, preencha os<br>campos “Key” e “Value” respectivamente com Ocp-Apim-Subscription-Key e o valor da “API<br>key” adquirida da etapa anterior. Selecione também a a opção “Header” no campo “Add to”.
Para esta transação, use o método "POST" e a url https://api.biopassid.com/multibiometrics/enroll, conforme descrito na documentação. Veja abaixo o resultado destas configurações:
4. Configure os parâmetros
As informações do corpo da requisição são passadas em formato JSON (acrônimo para JavaScript Object Notation), um padrão de formatação de dados amplamente utilizado na troca de informações entre sistemas por ser leve e de fácil compreensão para humanos e máquinas.
Agora, o corpo da operação possui uma estrutura do tipo Person que representa um indivíduo e suas biometrias, onde é incluída a variável CustomID.
Esta variável nada mais é do que um conjunto de caracteres conhecido como string, usado para identificar um indivíduo. É importante saber que o CustomID deve ser necessariamente único. Para isso, recomenda-se utilizar o CPF do usuário a ser registrado.
Finalmente, uma coleção de conjuntos de caracteres, a variável Face, ou seja, um array de strings, armazena as imagens faciais do usuário. Veja um exemplo da estrutura na imagem abaixo:
Se você enviar mais de uma captura, atribua Face-1, Face-2, e assim por diante.
Para facilitar, disponha do seguinte código de operação:
5. Converta a imagem em base64
Para incorporar uma imagem em um arquivo de texto em formato JSON, você precisa convertê-la em base64.
Base64 é um algoritmo de codificação que transforma diferentes tipos de arquivos e caracteres de qualquer idioma em um alfabeto latino, dígitos e sinais. Com isso, podemos converter imagens em uma seqüência de caracteres legíveis para qualquer computador,
que pode ser salvo e/ou transferido para qualquer outro lugar.
É frequentemente utilizado para transmitir dados binários através de transmissões que lidam apenas com texto, como requisições em APIs.
Há vários websites que realizam esta codificação de forma rápida e eficiente. Para o passo a passo, será utilizado o conversor deste link: https://base64.guru/converter/encode/file. Uma vez que você esteja na página, simplesmente:
- Escolha o arquivo de imagem facial.
- Clique no botão "Encode file to Base64".
- E copie o conteúdo.
6. Resposta da requisição
É sempre importante avaliar o código de resposta de uma chamada de API, pois é por meio deste código que sabemos se a operação ocorreu ou não como o esperado.
Em caso de erro, o status da resposta retornará um código numérico de três dígitos, começando com os números 4 ou 5. Um exemplo de falha para este tipo de requisição é o retorno da mensagem "Invalid JSON Format" (Formato JSON inválido).
O erro ocorre quando o base64 de algum dos campos Face ou Fingers está vazio, com
erros de pontuação, excesso ou falta de caracteres. A imagem a seguir demonstra esta situação:
Outros tipos de erros e suas causas podem ser encontrados na documentação do BioPass ID.
Agora, se todas as variáveis no corpo da requisição estiverem corretamente preenchidas e não houver erro na configuração da chamada e na sintaxe do JSON enviado (o body da requisição), você recebe como resposta o status "200 OK" e o objeto Person com três campos:
- CustomerID
- CustomID.
- BioPassID.
Dê uma olhada na imagem abaixo para entender melhor como deve ser uma operação de sucesso. Ela mostra o conteúdo da solicitação e a resposta.
Com as etapas concluídas e um pedido bem sucedido, você tem o cadastro biométrico facial de um indivíduo armazenado e pode posteriormente verificar sua identidade com base neste registro inicial.
Conheça e teste todos os recursos que o pacote de API Biométrica oferece.
