Resultados

Resultados ofrecidos por el componente SelphID Widget.

En esta página explicaremos las diferentes posibilidades para finalizar el proceso de captura del widget.

Cada detalle de cada evento (atributos, datos...) ha sido especificado en la página de (eventos).

Casos de éxito

Captura y extracción satisfactoria

En el momento en que la captura del documento tiene éxito, los resultados extraídos se ofrecerán en el evento extractionFinish (enlace).

Una vez que este evento es emitido, se debe implementar la lógica para cargar la siguiente vista o widget, adaptándose al contexto de la aplicación.

Aquí hay un ejemplo:

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.results.images.frontDocument, extractionFinishDetail.results.images.backDocument);

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

---

Casos de error

Se recomienda controlar los posibles errores que puedan ocurrir al procesar los datos obtenidos para evitar fallos internos, un uso incorrecto del widget o ataques de fuerza bruta.

Códigos de error

El widget lanzará una excepción si ocurre cualquier error de uso o interno.

Las excepciones podrán ser de dos tipos:

• Excepción terminal: Error que se lanzará cuando el widget no puede continuar con su ejecución. Estos errores pueden darse en entornos o configuraciones erróneas.

• Excepción de extracción: Error que se lanzará durante el flujo de captura o extracción. Estos errores permiten reintentar el flujo del widget, ya que se deben a un uso incorrecto del widget por parte del usuario.

Error	Código	Descripción
Excepciones terminales
AndroidWebViewBehaviour	SPD_318	Error producido tras la ejecución del componente en un WebView en un entorno android.
UnknownInternalError	SPD_329	Error interno en el widget. Si el error persiste será necesario contactar con el equipo de soporte de Facephi
CameraHardwareError	SPD_305	Error producido durante el acceso a cámaras del dispositivo.
PermissionsDenied	SPD_301	Error generado al no permitir los permisos necesarios para la ejecución del widget.
CameraPermissionDenied	SPD_301	Error al no conceder los permisos para utilizar la(s) cámara(s) del dispositivo.
MicrophonePermissionDenied	SPD_319	Error al no conceder los permisos para utilizar el(los) mocrófono(s) del dispositivo.
SettingsError	SPD_320	Error producido por una configuración incorrecta.
BrowserApiNotCompatible	SPD_321	Error producido por un navegador no compatible.
Exepciones de extracción
ErrorTimeout	SPD_001	Error generado al haber superado el límite de tiempo establecido para la extracción.

---

Límite de tiempo excedido durante la captura del documento

Con los eventos extractionTimeout(enlace) y timeoutErrorButtonClick(enlace) es posible controlar cuándo el usuario excede el tiempo establecido o los intentos utilizados.

Aquí hay un ejemplo:

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++;
}

---

El usuario cierra el widget antes de la captura del documento

Este evento se emite cuando el usuario hace clic en el icono de salida del widget para cancelar el proceso de extracción. Una vez que se presiona el botón, el widget se cerrará.

Ejemplo 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();
}

---

Excepciones terminales durante el ciclo de vida del Widget

Este evento se emite cuando se detecta un fallo del sistema. Puede ser utilizado para identificar y filtrar diferentes tipos de errores encontrados durante el proceso de captura.

Ejemplo 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);
}

---