Version: SNAPSHOT 🚧

Capture Component

0. Requisitos base de SDK Mobile

SDK Mobile es un conjunto de librerías (Componentes) que ofrece una serie de funcionalidades y servicios, permitiendo a su vez su integración en una aplicación Mobile de forma sencilla y totalmente escalable. Dependiendo del caso de uso que se requiera, se deberá realizar la instalación de unos determinados componentes. Su alto nivel de modularidad permite que, en un futuro, se puedan añadir otros componentes nuevos sin afectar en absoluto a los ya integrados en el proyecto.

Para más información sobre la configuración base, vaya a la sección de Primeros Pasos.

1. Introducción

El Componente tratado en el documento actual recibe el nombre de Capture Component. Éste se encarga de realizar la captura de facturas y la captura y generación de QRs.

1.1 Requisitos mínimos

La versión mínima de la SDK de iOS requerida es la siguiente:

Versión mínima de iOS: 14

2. Integración del componente

⚠️ Antes de integrar este componente se recomienda leer la documentación de Integración Inicial y seguir las instrucciones indicadas en dicho documento.

En esta sección se explicará paso a paso cómo integrar el componente actual en un proyecto ya existente.

2.1. Dependencias requeridas para la integración

⚠️ Para evitar conflictos y problemas de compatibilidad, en caso de querer instalar el componente en un proyecto que contenga una versión antigua de las librerías de Facephi (Widgets), éstos deberán eliminarse por completo antes de la instalación de los componentes de la SDKMobile.

Cocoapods

Actualmente las librerías de FacePhi se distribuyen de forma remota a través de diferentes gestores de dependencias, en este caso Cocoapods. Las dependencias obligatorias que deberán haberse instalado previamente (añadiéndolas en el fichero Podfile del proyecto) son:

  pod 'FPHISDKMainComponent', '~> 2.3.0'

Para instalar el componente de VideoID deberá incluirse la siguiente entrada en el Podfile de la aplicación:

  pod 'FPHISDKCaptureComponent', '~> 2.3.0'

Una vez instaladas las dependencias, se podrá hacer uso de las diferentes funcionalidades del componente.
En caso de realizar el desarrollo con XCode15 se deberá incluir un script de post-instalacion:

2.2 Permisos y configuraciones

En la aplicación cliente donde se vayan a integrar los componentes es necesario incorporar el siguiente elementos en el fichero info.plist

Es necesario permitir el uso de la cámara (Privacy - Camera Usage Description)

3. Iniciar nueva operación

Cuando se desea realizar una determinada operación, para generar la información asociada correctamente en la plataforma deberá ejecutarse previamente el comando newOperation.

ℹ️ Este comando debe haberse ejecutado anteriormente al lanzamiento del componente.

Para saber más acerca de cómo iniciar una nueva operación, se recomienda consultar la documentación de Iniciar nueva operación, en el que se detalla y explica en qué consiste este proceso.

4. Controladores disponibles

Controlador	Descripción
InvoiceReaderController	Controlador para la captura de facturas
QrReaderController	Controlador para la captura de QRs
QrGeneratorController	Controlador para la generación de QRs

5. Configuración del componente

Los tres controladores tienen funcionalidades independientes por lo que sus configuraciones también lo son:

InvoiceCaptureConfigurationData y pasarlo como parámetro al SDKController durante el lanzamiento del componente para Invoice.
QrCaptureConfigurationData y pasarlo como parámetro al SDKController durante el lanzamiento del componente de captura de QR
QrGeneratorConfiguration y pasarlo como parámetro al SDKController durante el lanzamiento del componente para generación de QRs.

En el siguiente apartado se mostrarán los campos que forman parte de estas clased y para qué se utiliza cada uno de ellos.

5.1. Class InvoiceCaptureConfigurationData

5.1.1 vibrationEnabled

Habilitar vibración durante el proceso

5.1.2 showDiagnostic

Mostrar pantallas de diagnóstico al final del proceso y en caso de error

5.1.3 showTutorial

Indica si el componente activa la pantalla de tutorial. En esta vista se explica de forma intuitiva cómo se realiza la captura.

5.1.4 timePreview

Se define el tiempo en milisegundos que dura la preview tras la captura, por defecto está en 2000

5.1.6 previewAfterCapture

Se habilita la preview tras la captura

5.1.7 maxScannedDocs

Número máximo de documentos capturados

5.1.8 showPreviousTip

Mostrar la pantalla de Tips previos

5.1.9 autoCapture

Habilitar la captura automática

5.2. Class QrCaptureConfigurationData

5.2.1. extractionTimeout

Tiempo de extracción máximo

5.2.2. cameraSelected

Cámara seleccionada: FRONT, BACK

5.2.3. cameraShape

Forma de la máscara que se quiere mostrar sobre la cámara:

SQUARE: Cuadrado
CIRCULAR: Círculo
RECTANGLE_TALL: Rectángulo

5.2.4. vibrationEnabled

Habilitar vibración durante el proceso

5.2.5. showStroke

Mostrar una línea como borde de la cámara

5.2.6. showDiagnostic

Mostrar pantallas de diagnóstico al final del proceso y en caso de error

5.2.7. transparentBackground

Máscara sobre la cámara semitransparente

5.3. Class QrGeneratorConfiguration

5.3.1. source

Texto que se va a incluir en el QR

5.3.2. width

Ancho del QR generado

5.3.3. height

Alto del QR generado

5.3.4 showDiagnostic

Mostrar pantallas de diagnóstico al final del proceso y en caso de error

6. Uso del componente

6.1 Captura de factura

Una vez iniciado el componente y creada una nueva operación (Apartado 3) se podrán lanzar los componentes del SDK. Hay dos formas de lanzar el componente:

[CON TRACKING] Esta llamada permite lanzar la funcionalidad del componente con normalidad, y trackeando los eventos internos al servidor de tracking:

let controller = InvoiceReaderController(data: invoiceCaptureConfigurationData, output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)
SDKController.shared.launch(controller: controller)

[SIN TRACKING] Esta llamada permite lanzar la funcionalidad del componente con normalidad, pero no se trackeará ningún evento al servidor de tracking:

let controller = InvoiceReaderController(data: invoiceCaptureConfigurationData, output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)
SDKController.shared.launchMethod(controller: controller)

⚠️ El método launch debe usarse por defecto. Este método permite utilizar tracking en caso de estar su componente activado, y no lo usará cuando esté desactivado (o no se encuentre el componente instalado).

Por el contrario, el método launchMethod cubre un caso especial, en el cual el integrador tiene instalado y activado el tracking, pero en un flujo determinado dentro de la aplicación no desea trackear información. En ese caso se usa este método para evitar que se envíe esa información a la plataforma.

6.2 Captura de QR

Una vez iniciado el componente y creada una nueva operación (Apartado 3) se podrán lanzar los componentes del SDK. Hay dos formas de lanzar el componente:

[CON TRACKING] Esta llamada permite lanzar la funcionalidad del componente con normalidad, y trackeando los eventos internos al servidor de tracking:

  let controller = QrReaderController(data: qrReaderConfigurationData, output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)

  SDKController.shared.launch(controller: controller)

[SIN TRACKING] Esta llamada permite lanzar la funcionalidad del componente con normalidad, pero no se trackeará ningún evento al servidor de tracking:

  let controller = QrReaderController(data: qrReaderConfigurationData, output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)
  SDKController.shared.launchMethod(controller: controller)

6.3 Generación de QR

Una vez iniciado el componente y creada una nueva operación (Apartado 3) se podrán lanzar los componentes del SDK. Hay dos formas de lanzar el componente:

[CON TRACKING] Esta llamada permite lanzar la funcionalidad del componente con normalidad, y trackeando los eventos internos al servidor de tracking:

  let controller = QrGeneratorController(data: qrGeneratorConfigurationData, output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)
  SDKController.shared.launch(controller: controller)

[SIN TRACKING] Esta llamada permite lanzar la funcionalidad del componente con normalidad, pero no se trackeará ningún evento al servidor de tracking:

  let controller = QrGeneratorController(data: qrGeneratorConfigurationData, output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)
  SDKController.shared.launchMethod(controller: controller)

7. Recepción del resultado

Los controllers devolverán la información necesaria en formato SdkResult. Más información en la sección de Retorno de Resultado.

7.1. Recepción de errores

En la parte del error, dispondremos de la clase común ErrorType.

public enum ErrorType: Equatable, Error {
    //COMMON - BASIC
    case NO_ERROR
    case UNKNOWN_ERROR
    case OTHER(String)
    
    //COMMON - REQUIREMENTS
    case NO_DATA_ERROR
    case NO_OPERATION_CREATED_ERROR
    case NETWORK_CONNECTION
    
    //COMMON - PERMISSIONS
    case CAMERA_PERMISSION_DENIED
    case MIC_PERMISSION_DENIED
    case LOCATION_PERMISSION_DENIED
    case STORAGE_PERMISSION_DENIED
    
    //COMMON - USER'S INTERACTION
    case CANCEL_BY_USER
    case TIMEOUT
    
    //COMMON - LICENSE ERROR
    case LICENSE_CHECKER_ERROR(String)
    case MISSING_COMPONENT_LICENSE_DATA
}

7.2. Recepción de ejecución correcta - data

En la ejecución correcta, simplemente se informa de que todo ha ido bien con el SdkResult.Success.

7.2.1 Result InvoiceReader

ScannedDocs

Array de documentos escaneados:

image: UIImage.
date: Date.

8. Personalización del componente

Aparte de los cambios que se pueden realizar a nivel de SDK (los cuales se explican en el documento de Personalización de la SDK), este componente en concreto permite la modificación de animaciones, imágenes, fuentes, colores y textos específicos.

Para personalizar el componente, se debe llamar a ThemeCaptureReaderManager.setup(theme: CustomThemeCaptureReader()) antes de lanzar invoiceReaderController:

let invoiceReaderController = InvoiceReaderController(data: InvoiceCaptureConfigurationData(), output: { sdkResult in
        // Do whatever with the result
        ...
    }, viewController: viewController)
ThemeCaptureReaderManager.setup(theme: CustomThemeCaptureReader())
SDKController.shared.launch(controller: invoiceReaderController)

Un ejemplo de la clase CustomThemeCaptureReader sería este (debe extender ThemeCaptureReaderProtocol):

class CustomThemeCaptureReader: ThemeCaptureReaderProtocol {
    var images: [R.Image: UIImage?] = [R.Image.ic_sdk_close: UIImage(named: "closeIcon")!]

    var colors: [R.Color: UIColor?] = [R.Color.sdkPrimaryColor: UIColor.red]

    var animations: [R.Animation: String] = [:]

    var name: String {
        "custom"
    }

    var fonts: [R.Font: String] = [:]

    var dimensions: [R.Dimension: CGFloat] {
        [.fontBig: 8]
    }
}

8.1 Imágenes

Las imagenes inicializan en la variable images, pasándole un diccionario, siendo la clave uno de los enumerados que representan las distintas imágenes de la pantalla, y el valor la imagen personalizada que se deba mostrar.

case ic_capture_capture
case ic_capture_pager_back
case ic_capture_pager_forward
case ic_capture_trash
case ic_capture_upload
case ic_sdk_close_arrow
case ic_sdk_close
case ic_sdk_logo
case ic_sdk_info

8.2 Colores

Los colores se inicializan similarmente en la variable colors con un diccionario, teniendo como valor un UIColor que se desee.

// COMMON SDK Colors 
case sdkPrimaryColor
case sdkBackgroundColor
case sdkSecondaryColor
case sdkBodyTextColor
case sdkTitleTextColor
case sdkSuccessColor
case sdkErrorColor
case sdkNeutralColor
case sdkAccentColor
case sdkTopIconsColor
// Capture Specific Colors
case sdkCaptureButtonColor
case sdkDisabledBackgroundColor

8.3 Fuentes

Las fuentes se inicializan similarmente en la variable fonts con un diccionario, teniendo como valor un String con el nombre de la UIFont que se desee.

case regular
case bold

El tamaño de los textos se inicializa similarmente en la variable dimensions con un diccionario, teniendo como valor un CGFloat con el tamaño deseado.

8.4 Animaciones

Las animaciones a usar se inicializan similarmente en la variable animations con un diccionario, teniendo como valor una string con el nombre de la animación que se encuentre en xcassets que se desee usar.

case phactura_anim_tip
case qr_anim_tip
case qr_anim_tuto_1
case qr_anim_tuto_2

8.5 Textos - Multiidioma

8.5.1 Configuración de idiomas por defecto

Si se instala el paquete mediante SPM, para que funcione la localización de textos, es necesario añadir en el archivo Info.plist de la app integradora lo siguiente:

CFBundleAllowMixedLocalizations = YES

Quedaría así:

Inglés
Español - España
Portugués - Portugal

El idioma del componente se puede configurar en el initSdk mediante el parámetro locale. En caso de no configurarse, el SDK escoge el idioma establecido en el dispositivo.

Si el idioma es cualquiera cuya raíz es el Español (p.e Español - México), por defecto, usará Español - España.
Si el idioma es cualquiera cuya raíz es el Portugués (p.e Portugués - Brasil), por defecto, usará Portugués - Portugal.
Para cualquier otro caso, se hará uso del Inglés.

8.5.2 Configuración de idiomas personalizada

El componente permite la personalización de los textos según el idioma, el cual al igual que en el anterior caso, será definido por el lenguaje que esté seleccionado en el dispositivo.

Esta personalización se aplica tanto a nuevas localizaciones como al caso de los idiomas predeterminados (es, en y pt). Se hace a través del uso de los archivos Localizable.strings.

8.5.3 Keys para multiidioma

Los textos pueden ser customizados sobreescribiendo el valor de las siguientes claves en un Localizable.strings. Las claves que contienen el sufijo _alt son los literales utilizados en las etiquetas de accesibilidad necesarias para la funcionalidad de voice over.

"capture_component_qr_camera_message" = "Mantén el QR en el centro";
"capture_component_qr_tutorial_title" = "Escanea el código QR";
"capture_component_qr_tutorial_desc" = "Enfoca el código QR dentro del recuadro";
"capture_component_qr_tutorial_button_message" = "COMENZAR";
"capture_component_qr_tutorial_1" = "Asegúrate de que el código QR tiene luz suficiente y no hay reflejos o destellos sobre el código.";
"capture_component_qr_tutorial_2" = "Encaja los bordes del código QR dentro del recuadro. ";
"capture_component_invoice_tip_button_message" = "COMENZAR";
"capture_component_exit_alert_question" = "¿Seguro que quiere finalizar el proceso? ";
"capture_component_exit_alert_accept" = "Aceptar";
"capture_component_exit_alert_cancel" = "Cancelar";
"capture_component_invoice_finish_button_message" = "Finalizar";
"capture_component_invoice_preview_finish_button_message" = "FINALIZAR";
"capture_component_invoice_remove_question" = "¿Quieres eliminar este documento?";
"capture_component_invoice_image_count_label" = "Imagen";
"capture_component_invoice_retry_button_message" = "NO, QUIERO REPETIR LA FOTOGRAFÍA";
"capture_component_invoice_retry_add_image_message" = "AÑADIR NUEVA FOTOGRAFÍA";
"capture_component_invoice_tip_title" = "Escanea tus documentos";
"capture_component_invoice_tip_desc" = "Haz una foto al documento, o sube una imagen. \nPuedes escanear varios documentos antes de finalizar";
"capture_component_invoice_close_alt" = "Cerrar";
"capture_component_invoice_upload_alt" = "Subir foto";
"capture_component_invoice_capture_alt" = "Capturar";
"capture_component_invoice_remove_alt" = "Eliminar";
"capture_component_invoice_back_image_alt" = "Imagen anterior";
"capture_component_invoice_forward_image_alt" = "Siguiente imagen";
"capture_component_timeout_title"="Tiempo superado";
"capture_component_timeout_desc"="Pedimos disculpas. No se ha podido hacer la captura.";
"capture_component_logo_alt" = "Logo";
"capture_component_qr_generation_failed_alert_title" = "La generación de QR ha fallado";
"capture_component_qr_generation_failed_alert_message" = "Por favor, vuelve a intentarlo";

De este modo, si se desea modificar por ejemplo el texto “COMENZAR” de la clave capture_component_invoice_tip_button_message para el idioma es-MX, se deberá ir al archivo Localizable.strings de la carpeta es-MX.lproj si es que existe (si no, se deberá crear) y ahí, añadir:

"capture_component_invoice_tip_button_message"="EMPEZAR";

Si un mensaje no se especifica en el fichero del idioma, este se rellenará con el mensaje por defecto.

0. Requisitos base de SDK Mobile​

1. Introducción​

1.1 Requisitos mínimos​

Versión mínima de iOS: 14​

2. Integración del componente​

2.1. Dependencias requeridas para la integración​

Cocoapods​

2.2 Permisos y configuraciones​

3. Iniciar nueva operación​

4. Controladores disponibles​

5. Configuración del componente​

5.1. Class InvoiceCaptureConfigurationData​

5.1.1 vibrationEnabled​

5.1.2 showDiagnostic​

5.1.3 showTutorial​

5.1.4 timePreview​

5.1.6 previewAfterCapture​

5.1.7 maxScannedDocs​

5.1.8 showPreviousTip​

5.1.9 autoCapture​

5.2. Class QrCaptureConfigurationData​

5.2.1. extractionTimeout​

5.2.2. cameraSelected​

5.2.3. cameraShape​

5.2.4. vibrationEnabled​

5.2.5. showStroke​

5.2.6. showDiagnostic​

5.2.7. transparentBackground​

5.3. Class QrGeneratorConfiguration​

5.3.1. source​

5.3.2. width​

5.3.3. height​

5.3.4 showDiagnostic​

6. Uso del componente​

6.1 Captura de factura​

6.2 Captura de QR​

6.3 Generación de QR​

7. Recepción del resultado​

7.1. Recepción de errores​

7.2. Recepción de ejecución correcta - data​

7.2.1 Result InvoiceReader​

ScannedDocs​

8. Personalización del componente​

8.1 Imágenes​

8.2 Colores​

8.3 Fuentes​

8.4 Animaciones​

8.5 Textos - Multiidioma​

8.5.1 Configuración de idiomas por defecto​

8.5.2 Configuración de idiomas personalizada​

8.5.3 Keys para multiidioma​

0. Requisitos base de SDK Mobile

1. Introducción

1.1 Requisitos mínimos

Versión mínima de iOS: 14

2. Integración del componente

2.1. Dependencias requeridas para la integración

Cocoapods

2.2 Permisos y configuraciones

3. Iniciar nueva operación

4. Controladores disponibles

5. Configuración del componente

5.1. Class InvoiceCaptureConfigurationData

5.1.1 vibrationEnabled

5.1.2 showDiagnostic

5.1.3 showTutorial

5.1.4 timePreview

5.1.6 previewAfterCapture

5.1.7 maxScannedDocs

5.1.8 showPreviousTip

5.1.9 autoCapture

5.2. Class QrCaptureConfigurationData

5.2.1. extractionTimeout

5.2.2. cameraSelected

5.2.3. cameraShape

5.2.4. vibrationEnabled

5.2.5. showStroke

5.2.6. showDiagnostic

5.2.7. transparentBackground

5.3. Class QrGeneratorConfiguration

5.3.1. source

5.3.2. width

5.3.3. height

5.3.4 showDiagnostic

6. Uso del componente

6.1 Captura de factura

6.2 Captura de QR

6.3 Generación de QR

7. Recepción del resultado

7.1. Recepción de errores

7.2. Recepción de ejecución correcta - data

7.2.1 Result InvoiceReader

ScannedDocs

8. Personalización del componente

8.1 Imágenes

8.2 Colores

8.3 Fuentes

8.4 Animaciones

8.5 Textos - Multiidioma

8.5.1 Configuración de idiomas por defecto

8.5.2 Configuración de idiomas personalizada

8.5.3 Keys para multiidioma