Oz Liveness WEB Adapter se configura mediante cambios en el archivo de configuración almacenado en el servidor de Oz Liveness WEB Adapter: /core/app_config.json
use_for_liveness:
la opción se utiliza cuando los gerentes del banco toman los videos de los clientes. Si la opción se establece como true
, los dispositivos móviles utilizan la cámara trasera por defecto; en el escritorio, el giro y el círculo oval se desactivan. Por defecto, la opción está configurada en false
;
preinit:
este parámetro opcional activa la carga preliminar de los scripts y la inicialización de la detección de rostros. Es necesario para reducir el tiempo de carga del complemento. El valor por defecto es off, lo que significa que todos los scripts se cargan después de llamar a OzLiveness.open()
. El valor script
significa que los scripts se cargarán antes de que se inicie el complemento. El valor full
permite la carga preliminar de los scripts y la inicialización de la detección de rostros.
architecture:
este parámetro opcional se utiliza para elegir la arquitectura de WebSDK. El valor por defecto es normal
. Si necesita la API Lite, use lite
;
api_url:
dirección del servidor Oz API, un parámetro de texto;
api_token:
token de acceso a Oz API, un parámetro de texto;
api_use_token:
aun parámetro para especificar la fuente del token de acceso a Oz API para el sistema. Valores posibles = config
, client
.
Si el valor del parámetro es client
, se espera un token de acceso a Oz API derivado del complemento JS;
Si especifica config
en este parámetro, se recuperará un token del parámetro api_token
del archivo de configuración del Oz Liveness WEB Adapter.
lang_allow:
idiomas disponibles en el sistema;
lang_default:
la configuración regional del sistema por defecto;
video_actions_list:
bloque de etiquetas de archivos de video utilizados en el sistema, una matriz de texto. Lista de etiquetas actual.
photo_actions_list:
bloque de etiquetas de archivos fotográficos utilizados en el sistema, una matriz de texto. Lista de etiquetas actual.
actions_default_importance:
este parámetro especifica si se permite redefinir la matriz de acciones desde el complemento WEB al iniciar el análisis. Valores posibles = true
, false
;
Si establece true
, el Adapter utilizará la matriz de acciones del archivo de configuración.
Si establece false
, el Adapter utilizará una matriz de acciones reenviada desde su navegador con el uso del método open(options)
.
actions_default:
la matriz de acciones. Las opciones incluyen:
video_count:
el número de archivos de video transmitidos, un parámetro numérico;
photo_front:
si el documento tiene un anverso. Valores posibles = true
, false
photo_back:
si el documento tiene un reverso. Valores posibles = true
, false
analyses:
un bloque para configurar el lanzamiento de los análisis. Las opciones incluyen:
quality:
lanzamiento del análisis de Oz Liveness. Valores posibles = true
, false
;
biometry:
lanzamiento del análisis Oz Biometry Valores posibles = true
, false
;
documents:
lanzamiento del análisis de Oz Text. Valores posibles = true
, false
.
extract_best_shot:
un parámetro que especifica si se debe adjuntar al resultado del análisis un enlace directo a la mejor toma extraída del video. Valores posibles = true
, false
;
result_mode:
un parámetro que especifica el contenido de la respuesta del servidor con los resultados de la verificación. Valores posibles:
safe:
sólo se devuelve el estado de los análisis (finalizado o aún no finalizado);
status:
se devuelven los resultados de los análisis realizados;
full:
La respuesta completa de Oz API sobre los análisis se devuelve en formato JSON;
result_codes:
bloque de códigos de respuesta con anotaciones;
delete_old_sessions:
true
, false
; si desea borrar las sesiones anteriores;
delete_old_sessions_offset_minutes:
***:
tiempo de eliminación de las sesiones anteriores (en minutos);
video_required_actions_list:
conjunto de acciones requeridas
save_lossless_frame:
true:
guardar el fotograma original sin compresión
video_file_format:
opcional; aquí puede elegir el formato de archivo de video. Este archivo de video se pasa a la api. Valores posibles: MOV, ZIP, el valor predeterminado es MOV.
Algunos de los parámetros del archivo de configuración pueden modificarse sin necesidad de editar directamente este archivo. Puede hacerlo utilizando las variables de entorno.
WA_ARCHITECTURE:
redefine el parámetro architecture
WA_API_URL:
redefine el parámetro api_url
Ejemplo del uso de variables de entorno al ejecutar una imagen docker de WebSDK en modo Lite:
WA_CORS_ORIGINS:
define qué orígenes están autorizados para realizar solicitudes. No hay un valor predeterminado. Tenga en cuenta que si no establece este valor, los encabezados CORS se desactivarán y no se los agregará al contenedor WebSDK.
WA_CORS_METHODS
(opcional):
métodos HTTP que se pueden utilizar. Si la variable no está establecida, asume el valor predeterminado que es 'GET, POST, OPTIONS
'. Si no se utiliza la variable, se acepta cualquier método.
WA_CORS_HEADERS
(opcional):
encabezados HTTP que se pueden utilizar. Si la variable no está establecida, asume el valor predeterminado que es 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type
'. Si no se utiliza la variable, se acepta cualquier encabezado.
Un ejemplo de uso de variables de entorno para la configuración del servidor:
Nota: para que el complemento funcione, la versión de su navegador debe ser la siguiente o más reciente.
Para poner el complemento en su página, agregue el archivo con estilos (ozliveness.css
) y el script principal del complemento (plugin_liveness.php
) al código HTML de la página. Los paquetes de idiomas necesarios se pueden especificar adicionalmente al activar el complemento. Si no se especifica ningún paquete de idiomas, se utilizará el idioma predeterminado. Ejemplo del código para agregar:
En el caso de las aplicaciones React, utilice head
en la página principal de su plantilla para cargar e inicializar el complemento OzLiveness..
La ventana del complemento se lanza con el método open(options)
. Parámetros:
options:
an object with the following settings:
token:
(opcional) el token de autorización
lang:
una cadena que contiene el identificador de uno de los paquetes de idiomas instalados;
meta:
objeto con los nombres de los meta campos en las claves y sus valores de cadena en los valores. Los metadatos se transfieren a Oz API y pueden utilizarse para obtener resultados de análisis;
params:
objeto con identificadores y parámetros adicionales:
extract_best_shot:
true
o false:
elegir el mejor fotograma en el análisis Quality;
action:
matriz de cadenas con identificadores de acciones a realizar.
Acciones disponibles:
photo_id_front: foto del anverso del documento de identidad;
photo_id_back: foto del reverso del documento de identidad;
video_selfie_left: giro de cabeza a la izquierda;
video_selfie_right: giro de cabeza a la derecha;
video_selfie_down: inclinación de la cabeza hacia abajo;
video_selfie_high: cabeza levantada;
video_selfie_scan: escaneo.
video_selfie_best: acción especial para seleccionar la mejor toma de un video y realizar el análisis de la misma en lugar del video completo.
on_submit():
función de devolución de llamada que se llama después de enviar los datos del cliente al servidor.
on_result(result):
función de devolución de llamada que se llama varias veces durante el análisis y recupera un resultado intermedio.
on_complete(result):
función de devolución de llamada que se llama después de finalizar la comprobación.
on_close():
función callback que se llama después de que se cierra la ventana del complemento (ya sea de forma manual por el usuario o automática una vez finalizada la comprobación).
Para mejorar la protección contra los ataques con un parámetro de action
sustituido en el lado del navegador e impedir la filtración de los resultados de la verificación, se recomienda utilizar el módulo Oz Liveness WEB SDK en condiciones reales sólo con la siguiente configuración:
Parámetro actions_default_importance
del archivo de configuración de Oz Liveness WEB Adapter: establecido en true
Parámetro result_mode del archivo de configuración de Oz Liveness WEB Adapter: establecido en 'safe
'.
Recuperar los resultados de los análisis con el método de Oz API Folder [SINGLE] (GET)
Con esta configuración, los parámetros de lanzamiento del módulo Oz Liveness WEB Plugin y los resultados de la verificación se almacenarán solo en servidores seguros, fuera del acceso de los ciberdelincuentes.
Un ejemplo de llamada segura a un método con la configuración predeterminada:
Si no se especifica ningún parámetro action
al lanzar el complemento, por defecto se llamará el formulario de verificación de Liveness (tomar video de una acción aleatoria). Tras ello, Oz API lanzará el análisis QUALITY. Puede configurar los ajustes por defecto en el lado del servidor.
Ejemplo de llamada a un método con la toma de fotos de un documento de identidad y una acción Liveness especificada:
Si se especifican las acciones photo_id_front
y photo_id_back
, se llamará los formularios de captura del anverso y el reverso de un documento de identidad, y Oz API lanzará los análisis DOCUMENTS y BIOMETRY. La especificación de una o varias acciones video_selfie_*
llama un formulario que tomará un video de el rostro del usuario y luego lanzará el análisis QUALITY. En cuanto finalicen los análisis, su resultado se devuelve a la función especificada en el parámetro on_complete
.
Durante la implementación y prueba del módulo Oz Liveness WEB SDK, utilícelo con la siguiente configuración para acelerar el proceso:
Parámetroactions_default_importance
de la configuración de Oz Liveness WEB Adapter: establecido en false
Parámetroresult_mode
de la configuración de Oz Liveness WEB Adapter: establecido en full
Importante: Para mejorar la protección contra ataques con un parámetro de action
sustituido en el lado del navegador e impedir la filtración de los resultados de la verificación, desaconsejamos el uso de esta configuración en condiciones reales.
El resultado de la verificación en este modo puede obtenerse en el complemento en formato JSON. Además, estos ajustes permiten anular el parámetro action
cuando el complemento se ejecuta en un navegador. Ejemplos de uso de un módulo con el parámetro action
anulado:
Ejemplo de llamada a un método con acciones de Liveness especificadas sin tomar fotos de un documento de identificación:
Especificar una o varias acciones video_selfie_*
llama un formulario que tomará un video de el rostro del usuario y luego lanzará el análisis de QUALITY en el lado de Oz API. Tras la finalización de los análisis, su resultado se devuelve a la función especificada en el parámetro on_complete
.
El método Close()
puede utilizarse para forzar el cierre de la ventana del complemento. Se cancelarán todas las solicitudes al servidor y las funciones de devolución de llamada (excepto on_close) dentro de la sesión actual.
Ejemplo de uso:
El método Hide()
puede utilizarse para ocultar la ventana del complemento sin cancelar las solicitudes de resultados de análisis y las funciones de devolución de llamadas de usuario. Utilice este método, entre otras cosas, si desea emitir su propio indicador de carga después de enviar los datos.
Ejemplo de uso:
El método add_lang(lang_id, lang_obj)
permite agregar un paquete de idiomas nuevo o personalizado.
Parámetros:
lang_id
: valor de cadena que puede ser utilizado posteriormente como parámetro lang para el método open()
;
lang_obj
: objeto que incluye identificadores de cadenas de traducción como claves y las propias cadenas de traducción como valores.
Ejemplo de uso:
Lista de todos los identificadores de idiomas:
Oz Liveness SDK es un módulo para el procesamiento de datos en los dispositivos de los clientes. Con el WebSDK de Oz Liveness, se pueden tomar fotos y videos de personas en sus navegadores web y luego analizar estos medios. La mayoría de los navegadores y dispositivos son compatibles.
Oz Liveness SDL consta de dos componentes:
Navegador | Versión |
---|---|
Lado del cliente: un archivo Javascript que se carga dentro de la parte del frontend de su aplicación. Se llama .
Lado del servidor: un módulo de servidor independiente con . El módulo se llama .
Google Chrome (y otros navegadores que funcionen con Chromium)
56
Mozilla Firefox
55
Safari
11
Microsoft Edge
17
Opera
47