Comece a usar o FACEIO

Crie e configure a aplicação:

1

Acesse o FACEIO Console ↗.

2

Na tela principal do Console, clique em Nova aplicação. Isso abrirá o Assistente de aplicações.

3

No Assistente de aplicações, siga as instruções exibidas. Informe o nome da aplicação e a URL da política de privacidade e selecione um Mecanismo de reconhecimento facial, uma região de armazenamento em nuvem ou implantação on-premises, as opções de segurança e a personalização do widget.

Clique para explorar o Assistente de aplicações

4

Revise a configuração e envie. Quando a aplicação for criada, você será direcionado ao Application Manager ↗, onde poderá gerenciar a nova aplicação com um guia de integração passo a passo.

1 Importe fio.js para o seu site

Cole o seguinte trecho antes da tag de fechamento </body> das páginas HTML em que deseja usar fio.js:

<div id="faceio-modal"></div>
<script src="https://cdn.faceio.net/fio.js"></script>

O trecho acima carrega fio.js de forma assíncrona. Uma página HTML básica pode inicializar a biblioteca assim:

<html>
  <head>
    <title>Login por reconhecimento facial</title>
  </head>
  <body>
    <div id="faceio-modal"></div>
    <script src="https://cdn.faceio.net/fio.js"></script>
  </body>
</html>

2 Crie um objeto faceIO

Para inicializar fio.js, crie um objeto faceIO() e informe o Public ID da aplicação, como mostrado abaixo. Você também pode inserir esse trecho após o código de importação da etapa 1. Para um exemplo completo, consulte o modelo HTML.

<script type="text/javascript">
   /* Inicialize fio.js com o Public ID da sua aplicação */
    const faceio = new faceIO("app-public-id");
</script>

Método enroll()

• Chame enroll() no objeto faceIO inicializado para cadastrar um novo usuário. O método abre o Widget FACEIO e inicia o cadastro facial a partir da página de cadastro ou onboarding do seu site.

• Ao chamar enroll(), o FACEIO Widget abre, solicita o consentimento e o acesso à câmera quando necessário e captura os dados faciais necessários para o cadastro. O mecanismo selecionado gera e indexa o hash biométrico usado em futuras autenticações.

• enroll() aceita vários parâmetros opcionais, como locale para o idioma da interação, permissionTimeout para o tempo de espera pelo acesso à câmera e payload para dados que você deseja associar ao usuário, como e-mail, nome ou ID. Esse payload é retornado depois de uma futura autenticação.

• enroll() retorna uma Promise que é resolvida com um objeto userInfo quando o cadastro é concluído. Ele inclui o Facial ID, a data do cadastro e as estimativas details.age e details.gender. Use o Facial ID como chave de consulta para a conta correspondente durante uma futura autenticação.

• Se o usuário negar o acesso à câmera ou rejeitar os Termos de Serviço, a Promise será rejeitada com o código de erro correspondente, como fioErrCode.PERMISSION_REFUSED ou fioErrCode.TERMS_NOT_ACCEPTED. Consulte a seção Códigos de erro para ver a lista completa.

• O método enroll(), seus parâmetros, valores retornados e tratamento de erros estão documentados no Guia de integração.

Método authenticate()

• Chame authenticate() no objeto faceIO inicializado para reconhecer um usuário já cadastrado. Use o método no fluxo de login do seu site ou aplicação web.

• Ao chamar authenticate(), o FACEIO Widget abre, solicita acesso à câmera quando necessário, executa as verificações configuradas de vivacidade e reconhecimento facial e retorna o resultado da autenticação.

• Dependendo da configuração de segurança da aplicação, após a identificação pelo mecanismo de reconhecimento facial, o usuário poderá precisar confirmar o PIN Code escolhido durante o cadastro para que o método authenticate() seja concluído.

• authenticate() aceita vários parâmetros opcionais, incluindo permissionTimeout para o tempo de espera pelo acesso à câmera, locale para o idioma da interação e outras opções documentadas nessa página.

• authenticate() retorna uma Promise resolvida com um objeto userData após a identificação. As principais propriedades são payload, com os dados associados durante o cadastro, e facialId, o identificador único do usuário. Use esses valores para localizar os dados do usuário no backend.

• O método authenticate(), seus parâmetros, valores retornados e tratamento de erros estão documentados no Guia de integração.

Cadastrar um novo usuário

O cadastro de um novo usuário, que extrai e indexa as características faciais após obter o consentimento, é iniciado com uma chamada a enroll():

// Crie um objeto faceIO com o Public ID da sua aplicação
const faceio = new faceIO("app-public-id");
function enrollNewUser(){
  faceio.enroll({
    "locale": "auto", // Idioma padrão do usuário
    "payload": {
        /* O payload associado a este usuário e retornado em uma futura autenticação. */
        "whoami": 123456, // ID de exemplo associado a este usuário
        "email": "john.doe@example.com"
        }
    }).then(userInfo => {
        // Usuário cadastrado com sucesso 
        alert(
            `Usuário cadastrado com sucesso. Detalhes:
           Facial ID único: ${userInfo.facialId}
           Data do cadastro: ${userInfo.timestamp}
           Gênero estimado: ${userInfo.details.gender}
           Idade aproximada: ${userInfo.details.age}`
        );
       console.log(userInfo);
       // Trate o resultado, armazene o Facial ID e redirecione para o painel
    }).catch(errCode => {
       // Registre o erro ocorrido durante o cadastro
       handleError(errCode);
    })
}

• Inicialização: Crie o objeto faceIO com o Public ID da aplicação. Substitua "app-public-id" pelo Public ID real obtido no FACEIO Console ↗.

• Chamada de cadastro: enroll() inicia o cadastro, solicita consentimento e acesso à câmera quando necessário e começa a extração das características faciais. O parâmetro payload permite associar dados ao usuário, como um ID de usuário (whoami) e um endereço de e-mail. Esse payload será retornado após uma futura autenticação.

• Resultado do cadastro: Quando o cadastro é concluído, a Promise é resolvida com um objeto userInfo que contém o Facial ID, a data do cadastro e as estimativas details.gender e details.age. Armazene o Facial ID no seu banco de dados para vincular futuras autenticações a esse usuário.

• Tratamento de erros: Capture as falhas de cadastro e implemente uma função handleError() para tratar corretamente os diferentes códigos. Consulte a documentação dos códigos de erro para ver todos os códigos disponíveis.

Autenticar um usuário existente

Da mesma forma, a autenticação de um usuário cadastrado anteriormente é iniciada com uma chamada a authenticate():

const faceio = new faceIO("app-public-id"); // Inicialize com o Public ID da sua aplicação
function authenticateUser(){
    faceio.authenticate({
        "locale": "auto" // Idioma padrão do usuário
    }).then(userData => {
        console.log("Sucesso, usuário identificado")
        // Leia o Facial ID retornado para este usuário. Ele permanece o mesmo
        // após cada autenticação bem-sucedida nesta aplicação.
        // Armazene-o como chave de consulta da conta correspondente no backend.
        console.log("Facial ID vinculado: " + userData.facialId)
        // Leia os dados que você associou a este usuário, se houver
        // durante o cadastro pelo parâmetro payload de enroll().
        console.log("Payload: " + JSON.stringify(userData.payload)) // Dados do payload do exemplo de enroll() acima
    }).catch(errCode => {
        handleError(errCode)
    })
}

• Inicialização: Inicialize o objeto faceIO com o Public ID da aplicação, como no exemplo de cadastro.

• Chamada de autenticação: authenticate() inicia a autenticação, solicita acesso à câmera quando necessário e executa o reconhecimento facial. O parâmetro locale define o idioma de interação do widget.

• Resultado da autenticação: Quando a autenticação é concluída, a Promise é resolvida com um objeto userData. userData.facialId é o identificador estável desse usuário em todas as autenticações. Use-o como chave principal para localizar o usuário no backend. O userData.payload contém os dados associados durante o cadastro, por exemplo {"whoami": 123456, "email": "john.doe@example.com"}.

• Tratamento de erros: Capture as falhas de autenticação e implemente uma função handleError() para tratar cada código retornado. Consulte a documentação dos códigos de erro para ver todos os códigos disponíveis.