Captura facial
Version 2.3.X
Introducción
La captura facial se realiza con el Selphi Component.
Este componente se encarga de realizar la captura de un selfie del usuario y de la posterior extracción de las características faciales más importantes. Sus principales procesos son:
Gestión interna de cámaras y permisos.
Asistente en los procesos de captura de la cara del usuario.
Generación de las plantillas con las características faciales y de la imagen del usuario.
En el apartado de Lanzamiento simplificado se detallan los pasos necesarios para la integración básica del SDK. En esta sección se añade la información para el lanzamiento de este componente.
Dependencia
La dependencia específica del componente es:
implementation "com.facephi.androidsdk:selphi_component:$version"Controladores disponibles
Este componente contiene varios controladores que ejecutan diferente funcionalidad:
Controlador
Descripción
SelphiController
Controlador principal de reconocimiento facial
RawTemplateController
Controlador para generar un RawTemplate a partir de una imagen
SignatureSelphiController
Controlador para firmar un proceso con una Captura
Lanzamiento simplificado
Una vez iniciado el SDK y creada una nueva operación se podrá lanzar el componente. Se podrá hacer uso de cualquiera de sus controladores para ejecutar su funcionalidad.
Lanzamiento de la captura facial:
Configuración básica
Para lanzar el componente actual, se deberá crear un objeto SelphiConfigurationData que será la configuración del controlador del componente.
La configuración básica necesaria para es la siguiente:
Los diferentes modos de lanzamiento son:
SelphiFaceLivenessMode.NONE
SelphiFaceLivenessMode.PASSIVE
SelphiFaceLivenessMode.MOVE
Recepción del resultado
El lanzamiento devolverá la información en formato SdkResult. Pudiendo diferenciarse entre un lanzamiento correcto y uno incorrecto:
Recepción de errores
Los errores se devolverán como un objeto 'SelphiError'.
Listado de errores:
SPI_ACTIVITY_RESULT_ERROR: El resultado de la actividad es incorrecto.
SPI_ACTIVITY_RESULT_MSG_ERROR: El resultado de la actividad recibido en el msg es incorrecto.
SPI_APPLICATION_CONTEXT_ERROR: El contexto de aplicación necesario es nulo.
SPI_BAD_EXTRACTOR_CONFIGURATION_ERROR: Widget: Configuración del extractor incorrecta.
SPI_CAMERA_PERMISSION_DENIED: El usuario ha rechazado los permisos.
SPI_CANCEL_BY_USER: El usuario ha cancelado el proceso.
SPI_CANCEL_LAUNCH: Se ha hecho una cancelación general del SDK.
SPI_COMPONENT_LICENSE_ERROR: La licencia del componente no es correcta.
SPI_CONTROL_NOT_INITIALIZATED_ERROR: Widget: Error de inicialización.
SPI_EMPTY_LICENSE: El String de licencia está vacío.
SPI_EXTRACTION_LICENSE_ERROR: Widget: Error de licencia.
SPI_FETCH_DATA_ERROR: Error en la recogida del resultado.
SPI_FLOW_ERROR: Error en el proceso de flow.
SPI_HARDWARE_ERROR: Widget: Error de hardware.
SPI_INITIALIZATION_ERROR: Error de inicialización.
SPI_MANAGER_NOT_INITIALIZED: Los managers son nulos.
SPI_NO_DATA_ERROR: Los datos de entrada son nulos.
SPI_OPERATION_NOT_CREATED: No hay ninguna operación en curso.
SPI_RESOURCES_NOT_FOUND: No se ha encontrado el zip de recursos.
SPI_SETTINGS_PERMISSION_ERROR: Widget: Error de permisos.
SPI_TEMPLATE_ERROR:
SPI_TIMEOUT: Timeout en el proceso.
SPI_UNEXPECTED_CAPTURE_ERROR: Widget: Error en la captura.
SPI_UNKNOWN_ERROR: Error desconocido.
SPI_WIDGET_RESULT_DATA_ERROR: Error en los datos de salida del widget.
Recepción del resultado correcto - data
En la parte de SdkResult.Success - data, dispondremos de la clase SelphiResult.
El resultado devuelve las imágenes en formato SdkImage, es posible extraer el bitmap accediendo a image.bitmap. Si se quisiera convertir a base64 se puede utilizar la función:
Base64.encodeToString(this.toByteArray(), Base64.NO_WRAP)
Los campos devueltos en el resultado son los siguientes:
templateRaw
Devuelve la plantilla en bruto que se genera después del proceso de extracción. Válida para el proceso de matching.
template
Devuelve la plantilla que se genera después del proceso de extracción. Válida para el proceso de matching.
bestImage
Devuelve la mejor imagen extraída del proceso de autenticación. Esta imagen tiene el tamaño original extraída de la cámara. Válida para el proceso de liveness.
bestImageCropped
Devuelve una imagen recortada centrada en la cara del usuario. Esta imagen se obtiene a partir de la bestImage.
logImages
Lista con las 5 mejores imágenes capturadas. Se devuelve si se activa el flag "logImages" en la configuración.
bestImageTokenized
Devuelve la mejor imagen extraída en el proceso cifrada. Válida para el proceso de liveness.
Información avanzada
Este apartado amplía la información del componente.
Controladores Adicionales
SignatureSelphiController
Se utiliza de la misma manera que SelphiController con la diferencia de que genera un fichero de firma en la plataforma.
RawTemplateController
Controlador para generar un RawTemplate a partir de una imagen (bitmap).
Ejemplo de uso:
Configuración avanzada del componente
Para lanzar el componente actual, se deberá crear un objeto SelphiConfigurationData que será la configuración del controlador del componente.
A continuación se detallan todos los campos que forman parte de esta clase.
resourcesPath
Indica el nombre de los recursos en formato zip del componente. Ejemplo: “resources-selphi-2-0.zip“.
Este nombre irá a buscar el fichero a la ruta de assets.
cropPercent
Permite modificar el porcentaje de recortado de la cara. Cuanto mayor sea el número mayor será el recorte del rectángulo con respecto a la cara.
cropImageDebug
Permite al modo de depuración comprobar el porcentaje de recorte de la cara.
showResultAfterCapture
Indica si mostrar o no una pantalla con la imagen capturada después del proceso de análisis. En esta pantalla se le da al usuario la posibilidad de repetir el proceso de captura si la imagen que se obtuvo no fuera correcta.
showTutorial
Indica si el widget activa la pantalla de tutorial. En esta vista se explica de forma intuitiva cómo se realiza la captura.
livenessMode
Establece el modo liveness del widget. Los valores permitidos son:
SelphiFaceLivenessMode.NONE: Indica que no debe activarse el modo detección de foto en los procesos de autenticación.
SelphiFaceLivenessMode.PASSIVE: Indica que la prueba de vida pasiva se realiza en el servidor, enviando para tal fin la “BestImage” o el “TemplateRaw” correspondiente.
SelphiFaceLivenessMode.MOVE: Indica que el test de liveness es activo, mostrando unas instrucciones durante la captura, y devolviendo el correspondiente resultado del proceso.
stabilizationMode
Establece un modo de estabilización previo a cualquier proceso de autenticación en el widget. Con este modo se obliga al widget a no empezar ningún proceso si el usuario no se encuentra con la cabeza, mirando al frente y sin moverla.
cameraFlashEnabled
Indica si se activa el flash de la cámara del dispositivo.
fullscreen
Indica si la vista va a tener prioridad para mostrarse en pantalla completa, si el sistema lo permite.
templateRawOptimized
Indica si el template (templateRaw) generado tras el selfie debe optimizarse o no.
qrMode
Booleano que indica si se quiere o no activar la lectura de QR previo al proceso de autenticación.
videoFilename
Establece la ruta absoluta del nombre del archivo en el que se grabará un video del proceso de captura. La aplicación es la responsable de solicitar los permisos necesarios al teléfono en caso de que esa ruta requiera de permisos adicionales. El widget, por defecto, no realizará ningún proceso de grabación a menos que se especifique una ruta de archivo mediante este método.
viewsContent
Esta propiedad avanzada permite, mediante una cadena en formato xml, configurar las vistas del widget.
Nota: Esta propiedad no altera el contenido del archivo de recursos.
showDiagnostic
Mostrar pantallas de diagnóstico al final del proceso
logImages
Al activarlo se devuelve una lista con las 5 mejores imágenes tomadas del usuario
showPreviousTip
Muestra una pantalla previa al lanzamiento de la captura con información sobre el proceso a realizar y un botón para el lanzamiento.
extractionDuration
Duración del proceso de extracción facial
cameraPreferred
Cámara con la que se quiere realizar el proceso: FRONT, BACK
vibrationEnabled
Indica si se desea un feedback de vibración al acabar el proceso.
moveSuccessfulAttempts
Número de reintentos para la captura correcta en el proceso de movimiento (Por defecto 1)
moveFailedAttempts
Número de reintentos para la captura incorrecta en el proceso de movimiento (Por defecto 2)
Personalización del componente
Además de los cambios que se pueden realizar a nivel de SDK (los cuales se explican en el documento de Personalización del SDK), este componente en concreto permite su propia personalización.
Textos
Si se desea modificar los textos de la SDK habría que incluir el siguiente fichero XML en la aplicación del cliente, y modificar el valor de cada String por el deseado.
Name
Value
selphi_component_timeout_title
Tiempo superado
selphi_component_timeout_desc
No hemos podido identificarte. Inténtalo de nuevo
selphi_component_internal_error_title
Hubo un problema técnico
selphi_component_internal_error_desc
Pedimos disculpas. No se ha podido hacer la captura
selphi_component_tip_message
Coloca tu cara en el centro del círculo
selphi_component_tip_message_alt
Coloca tu cara en el centro del círculo
selphi_component_tip_anim_alt
Una persona muestra su cara dentro del círculo y la aplicación le hace una foto.
selphi_component_tip_title
Reconocimiento facial
selphi_component_tip_button
COMENZAR
selphi_component_tip_button_alt
Comenzar captura de rostro
selphi_component_tip_move_message
Coloca tu cara en el centro del círculo y sigue las indicaciones
selphi_component_tip_move_message_alt
Coloca tu cara en el centro del círculo y sigue las indicaciones
selphi_component_tip_move_anim_alt
Una persona muestra su cara dentro del círculo, la mueve ligeramente hacia un lado y la aplicación le hace una foto.
selphi_component_tip_move_title
Reconocimiento facial
selphi_component_tip_move_button
COMENZAR
selphi_component_qr_tip_title
Escanea el código QR
selphi_component_qr_tip_message
Enfoca el código QR dentro del recuadro
selphi_component_qr_tip_anim_alt
Enfoca el código QR dentro del recuadro
selphi_component_qr_tip_button
Comenzar
selphi_component_tip_close_button_alt
Volver
selphi_component_tip_info_button_alt
Ver consejos
selphi_component_tutorial_message_1
Coloca tu cara en el centro y mira de frente a la cámara.
selphi_component_tutorial_message_2
Retira cualquier elemento que cubra tu cara.
selphi_component_tutorial_message_3
Busca un entorno bien iluminado, sin sombras sobre tu rostro.
selphi_component_tutorial_1_anim_alt
La foto se realiza cuando la persona está en el centro.
selphi_component_tutorial_2_anim_alt
Una persona se quita las gafas de sol y se retira el pelo de los ojos.
selphi_component_tutorial_3_anim_alt
La imagen aparece oscura y una persona enciende la luz.
selphi_component_tutorial_close_button_alt
Volver al tutorial previo
Animaciones
Si se desea modificar las animaciones (lottie) de la SDK habría que incluir las animaciones con el mismo nombre en la carpeta res/raw/ de la aplicación.
Last updated