En el siguiente gráfico, se puede observar el ciclo básico de integración.

Este repositorio contiene una aplicación de ejemplo escrita en Kotlin para Android. La aplicación demuestra cómo integrar el flujo de firma o identificación de Keynua utilizando un WebView. El objetivo es mostrar cómo implementar y manejar de manera efectiva el flujo de autenticación de Keynua dentro de una aplicación Android.

• Permisos de la aplicación: Antes de inicializar el WebView, la aplicación configura y solicita los permisos necesarios para el uso de la cámara y el micrófono.

• Integración con WebView: Explica cómo cargar el flujo de Keynua dentro de un WebView.

• Detección de eventos: La aplicación identifica cuándo finaliza el flujo de validación en el WebView. Para detectar estos eventos, la URL cargada en el WebView debe contener una URL personalizada que servirá como callback para enviar la información de cada uno de los Tipos de Eventos.

• Android Studio 4.0 o superior.
• Acceso a internet para la carga del flujo de Keynua.

1. Clona este repositorio.
2. Abre el proyecto en Android Studio.
3. Modifica el valor del Token de usuario en la aplicación
4. Sincroniza y construye el proyecto con Gradle.
5. Ejecuta la aplicación en un dispositivo o emulador Android.

1. Navega al WebView en la aplicación.
2. El flujo de Keynua se cargará automáticamente.
3. Completa el proceso en el WebView.
4. Observa la respuesta de la aplicación al finalizar el flujo.

Para recibir los eventos del flujo de firma o identificación en tu aplicación, debes definir una URL personalizada para cada tipo de evento descrito a continuación. Utilizaremos esta URL como callback para cada evento, enviando la información correspondiente como parámetros en la consulta (query param). Tu aplicación podrá detectar la URL, extraer la información y procesarla según sea necesario.

Debe enviarse el atributo eventDoneURL. Si se detecta una URL en este parámetro, se añadirá un botón "Finalizar" al concluir la validación. Al presionar este botón, la aplicación ejecutará la URL contenida en el parámetro, agregando los siguientes valores como parte de la consulta:

• status: En este evento, el valor siempre será done.
• identificationId: ID de la identificación. Se enviará solo si es una identificación.
• contractId: ID del contrato. Se enviará solo si es un contrato.

Si deseas redirigir a myapp://com.company.example al finalizar el flujo, la URL del WebView debe estructurarse de la siguiente manera:

https://sign.keynua.com/index.html?token=eyJ0...Qis&eventDoneURL=myapp://com.company.example

Debe enviarse el atributo eventErrorURL. Si se detecta una URL en este parámetro, se enviará un callback cada vez que ocurra un error en el flujo.

• status: En este evento, el valor siempre será error.
• errCode: Código de error que permite determinar cómo reaccionar. La lista de errores se encuentra en la sección "Errores por tipo de ítem" de la documentación.
• errMsg: Descripción del error recibido.
• errItemId (opcional): ID del ítem con error. Este es un valor único del contrato o identificación. Más información en la sección Propiedades de un ítem.
• errItemType (opcional): Tipo de ítem asociado al error. Más información en Tipos de ítem.

Si deseas enviar la información de error a myapp://com.company.example, la URL del WebView debe estructurarse de la siguiente manera:

https://sign.keynua.com/index.html?token=eyJ0...Qis&eventErrorURL=myapp://com.company.example

Debe enviarse el atributo eventLogURL. Si se proporciona este parámetro, se enviarán logs del flujo de validación en tiempo real, lo que permitirá monitorear en qué estado se encuentra el usuario dentro del proceso.

• status: En este evento, el valor siempre será info.

• funnelId: Hace referencia al paso actual en el que se encuentra el usuario. Puede tener los siguientes valores:

  • 3DLibraryDownloadStarted: Comenzó la descarga de la librería 3D.
  • 3DLibraryDownloadError: Ocurrió un error al descargar la librería 3D.
  • 3DLibraryDownloadFinished: Finalizó la descarga de la librería 3D.
  • -1:__processdata: La información ha comenzado a enviarse para su procesamiento.
  • -1:Nothingmore: La información se ha enviado correctamente y el usuario está a la espera de que el proceso termine.
  • -1:Finished: El flujo ha finalizado correctamente.

  Si el funnelId hace referencia a un paso dentro del flujo de firma o identificación, tendrá el siguiente formato: ${funnelOrder}:${groupId}:${itemTitle}.

  Ejemplo: "2:verificantes-1:Aceptación de Términos", donde:

  • funnelOrder: Orden del ítem dentro del contrato. Usualmente, el ítem de "Términos y Condiciones" tiene el menor valor, ya que es el primero que se muestra.
  • groupId: ID del grupo en el que se encuentra el usuario. Si el funnelId hace referencia a un ítem sin grupo, este valor no se enviará.
  • itemTitle: Título del ítem.

• action: Indica la acción realizada. Puede tener los siguientes valores:

  • render-view: Cuando la vista se ha mostrado.
  • input-value-changed: Cuando el usuario ha finalizado la acción en la vista actual. Por ejemplo, aceptó los Términos y Condiciones o finalizó el paso de la Prueba de Vida 3D
  • 3d-started: Indica que el usuario ha comenzado el flujo de Prueba de Vida 3D y/o validación del Documento de Identidad 3D.
  • 3d-finished: Indica que el flujo de Prueba de Vida 3D y/o validación del Documento de Identidad 3D ha finalizado. Si ha ocurrido un error en el flujo, recibirás el detalle en el Evento de Error

Si deseas enviar la información de los logs a myapp://com.company.example, la URL del WebView debe estructurarse de la siguiente manera:

https://sign.keynua.com/index.html?token=eyJ0...Qis&eventLogURL=myapp://com.company.example

Para consultas, puedes contactarnos a operaciones@keynua.com