Resultados

Resultados oferecidos pelo componente SelphID Widget.

Nesta página explicaremos as diferentes possibilidades para finalizar o processo de captura do widget.

Cada detalhe de cada evento (atributos, dados...) foi especificado na página de (eventos).

Casos de sucesso

Captura e extração bem-sucedidas

No momento em que a captura do documento for bem-sucedida, os resultados extraídos serão disponibilizados no evento extractionFinish (link).

Assim que este evento for emitido, a lógica para carregar a próxima tela ou widget deve ser implementada, adaptando-se ao contexto da aplicação.

Aqui há um exemplo:

import { type ExtractionFinishEvent } from "@facephi/selphid-web-component"

const selphidWidget = document.querySelector('facephi-selphid-widget');
selphidWidget.addEventListener('extractionFinish', onExtractionFinish);

function onExtractionFinish(event: CustomEvent<ExtractionFinishEvent>) {
  const extractionFinishDetail = event.detail.detail;
  console.log('extractionFinish:', extractionFinishDetail);

  // Procesar resultados en el backend
  saveResults(extractionFinishDetail.result.images.frontDocument, extractionFinishDetail.result.images.backDocument);

  // Cargar el siguiente widget o vista
  loadSelphiWidget();
}

---

Casos de erro

Recomenda-se controlar os possíveis erros que possam ocorrer ao processar os dados obtidos para evitar falhas internas, uso incorreto do widget ou ataques de força bruta.

Códigos de erro

O widget lançará uma exceção se ocorrer qualquer erro de uso ou interno.

As exceções poderão ser de dois tipos:

• Exceção terminal: erro que será lançado quando o widget não puder continuar sua execução. Esses erros podem ocorrer em ambientes ou configurações incorretas.

• Exceção de extração: erro que será lançado durante o fluxo de captura ou extração. Esses erros permitem tentar novamente o fluxo do widget, já que decorrem de um uso incorreto do widget por parte do usuário.

Erro	Código	Descrição
Exceções terminais
AndroidWebViewBehaviour	SPD_318	Erro gerado após a execução do componente em um WebView em um ambiente Android.
UnknownInternalError	SPD_329	Erro interno no widget. Se o erro persistir, será necessário entrar em contato com a equipe de suporte da Facephi
CameraHardwareError	SPD_305	Erro gerado durante o acesso às câmeras do dispositivo.
PermissionsDenied	SPD_332	Erro gerado ao não permitir as permissões necessárias para a execução do widget.
CameraPermissionDenied	SPD_301	Erro ao não conceder as permissões para utilizar a(s) câmera(s) do dispositivo.
MicrophonePermissionDenied	SPD_319	Erro ao não conceder as permissões para utilizar o(s) microfone(s) do dispositivo.
SettingsError	SPD_320	Erro gerado por uma configuração incorreta.
BrowserApiNotCompatible	SPD_321	Erro gerado por um navegador não compatível.
Exceções de extração
ErrorTimeout	SPD_001	Erro gerado ao ter excedido o limite de tempo estabelecido para a extração.

---

Limite de tempo excedido durante a captura do documento

Com os eventos extractionTimeout(link) e timeoutErrorButtonClick(link) é possível controlar quando o usuário excede o tempo estabelecido ou as tentativas utilizadas.

Aqui há um exemplo:

import { type ExtractionTimeoutEvent, type TimeoutButtonClickEvent } from "@facephi/selphid-web-component";

const selphidWidget = document.querySelector('facephi-selphid-widget');
selphidWidget.addEventListener('extractionTimeout', onErrorTimeout);
selphidWidget.addEventListener('timeoutErrorButtonClick', onTimeoutButtonClick);
let userRetries = 0;

// El usuario no ha completado la extracción dentro del tiempo permitido
const onExtractionTimeout = (event: CustomEvent<ExtractionTimeoutEvent>) => {
  if (userRetries >= 3) {
    // Redirigir al usuario a una vista de error
    showRetriesExceededView();
  }
}

// El usuario ha hecho clic en el botón para reintentar la extracción en la vista de tiempo de espera del widget
const onTimeoutButtonClick = (event: CustomEvent<TimeoutButtonClickEvent>) => {
  userRetries++;
}

---

O usuário fecha o widget antes da captura do documento

Este evento é emitido quando o usuário clica no ícone de saída do widget para cancelar o processo de extração. Assim que o botão for pressionado, o widget será fechado.

Exemplo de código

import { type UserCancelEvent } from "@facephi/selphid-web-component";

const selphidWidget = document.querySelector('facephi-selphid-widget');
selphidWidget.addEventListener('userCancel', handleUserCancel);

// El usuario ha hecho clic en el icono de salida del widget para cancelar el proceso de extracción
function handleUserCancel(event: CustomEvent<UserCancelEvent>) {
  // Redirigir al usuario a la página principal del sitio web
  goLandingPage();
}

---

Exceções terminais durante o ciclo de vida do Widget

Este evento é emitido quando uma falha do sistema é detectada. Pode ser usado para identificar e filtrar diferentes tipos de erros encontrados durante o processo de captura.

Exemplo de código:

import { type ExceptionCapturedEvent, type ErrorTimeoutEvent } from "@facephi/selphid-web-component";

const selphidWidget = document.querySelector('facephi-selphid-widget');
selphidWidget.addEventListener('exceptionCaptured', handleExceptionCaptured);
selphidWidget.addEventListener('errorTimeout', handleErrorTimeout);

// Se detecta un mal funcionamiento y el widget se ha detenido
function handleExceptionCaptured(event: CustomEvent<ExceptionCapturedEvent>) {
  const exceptionDetail = event.detail.detail;
  console.error('Widget Exception:', exceptionDetail.exceptionType);
}

// Se ha alcanzado el tiempo establecido en la propiedad `errorTimeout`
function handleErrorTimeout(event: CustomEvent<ErrorTimeoutEvent>) {
  const errorTimeoutDetail = event.detail.detail;
  // Redirigir al usuario a una vista de error
  showErrorView(errorTimeoutDetail.exceptionType);
}

---