oiti-liveness-2d v2.0.0

oiti-liveness-2D

O oiti-liveness-2D é uma biblioteca para realizar reconhecimento facial em aplicações Vue.js com uma interface simples e fácil de integrar. Ele fornece uma interface configurável para ser usada em diferentes projetos Vue.js.

Instalação

Necessário vuejs versão 2.x

Para instalar o package via npm:

npm install oiti-liveness-2d

Ou via yarn:

yarn add oiti-liveness-2d

Uso Básico

Configuração no Projeto

No arquivo main.js do seu projeto, importe e registre o package da seguinte maneira:

import Vue from 'vue';
import oitiLiveness2D from 'oiti-liveness-2d';
import 'oiti-liveness-2d/dist/oitiLiveness2D.css'

// ...

Vue.config.productionTip = false;

Vue.use(oitiLiveness2D, {
  url: 'url-to-get-biometry-result',
  token: 'token-pipeline',
  workflow: 'ioti-workflow-type'
});

new Vue({
  render: h => h(App),
}).$mount('#app');

Exemplo de Uso no Componente

Use o componente oiti-liveness-2D diretamente no seu projeto. Aqui está um exemplo de como integrá-lo:

<template>
  <div>
    <oiti-liveness-2d
      :appkey="appkey-here"
      :ticket="ticket-here"
      :show-instructions="true" // default true
      :start-on-video="false" // default false
      @on-success="onSuccess"
      @on-error="onError"
    />
  </div>
</template>

<script>
export default {
  data() {
    return {
      appkey: 'SUA_APP_KEY_AQUI',
    };
  },
  methods: {
    onSuccess() {
      console.log('Liveness verification successful!');
    },
    onError(error) {
      console.error('Liveness verification failed:', error);
    },
  },
};
</script>

Propriedades(Props)

O componente suporta as seguintes props:

• appkey: (obrigatório) A chave de autenticação para utilizar o serviço de facecaptcha.
• ticket: (obrigatório) Ticket retornando na autenticação para consultar o status da biometria.
• showInstructions: (opcional) Exibe ou oculta as instruções de reconhecimento facial. Padrão: true.
• startOnCamera: (opcional) Se verdadeiro, o vídeo será iniciado automaticamente ao carregar o componente. Padrão: false.
• onSuccess: (opcional) Callback que será chamado após a verificação de liveness ser bem-sucedida.
• showToast: (opcional) Se verdadeiro, exibe notificações do componente. Padrão: true.

Eventos Emitidos

O componente emite os seguintes eventos:

• validation-success: Disparado quando a verificação facial for bem-sucedida.
• validation-error: Disparado quando houver falha na verificação facial. O erro é passado como parâmetro no evento.

Métodos Relevantes

• startLiveness(): Inicia o processo de reconhecimento facial manualmente.
• closeLiveness(): Fecha a área de vídeo e interrompe o fluxo de reconhecimento facial.
• startCapture(): Inicia a captura de imagem e envia os dados para o serviço de verificação.

Conclusão

O oiti-liveness-2D é uma lib flexível que pode ser integrada em qualquer aplicação Vue.js. Para garantir o uso adequado da lib, certifique-se de configurar corretamente os eventos e tratar sucessos e erros da verificação facial.