iOS

BCC Finger es una biblioteca destinada a integrarse en una aplicación iOS desde un .framework archivo. Utiliza la cámara del dispositivo para tomar una foto de huellas dactilares con fines biométricos.

Este manual está actualizado para BCC Finger Photo iOS versión 4.3.0.

Requisitos

• Git

• Cocoapods, disponible en https://cocoapods.org/.

Instalación

Instalación de dependencias

1 - Agregue los siguientes Pods a las dependencias de la aplicación en el Podfile:

pod 'lottie-ios'

Si la aplicación no tiene un Podfile, se puede crear en la carpeta raíz de su proyecto Xcode usando el comando pod init en la terminal.

Es preferible usar frameworks dinámicos. Se puede indicar usando la bandera use_frameworks! en el Podfile.

A continuación se muestra un ejemplo de Podfile con un target llamado BCCs-Sample:

target 'BCCs-Sample' do
	use_frameworks!

	pod 'lottie-ios', '~> 3.3.0'
end

post_install do |installer|
	installer.pods_project.targets.each do |target|
		target.build_configurations.each do |config|
			config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
		end
	end
end

Se recomienda usar la versión mínima de iOS compatible para su aplicación igual a la de este framework: iOS 13.0, como en el ejemplo anterior.

2 - Cierre su proyecto de Xcode y abra en la terminal la carpeta donde está su Podfile, luego ejecute:

$ pod install

Después de que termine la ejecución, se creará un archivo con la .xcworkspace extensión en la misma carpeta.

3 - Abra el nuevo archivo .xcworkspace .

A partir de ahora, cada vez que el usuario quiera abrir el proyecto, es necesario abrirlo a través de este .xcworkspace archivo, ya que incluye las dependencias.

Importación y configuración

Importando el proyecto

• Abra el proyecto usando el .xcworkspace .

• Agregue el archivo FingerPhoto.framework al proyecto, luego agréguele a la lista de frameworks de su aplicación.

  • Mueva el .framework archivo al árbol de archivos del proyecto.

    Si ya existe una carpeta de frameworks, se recomienda mover el archivo allí.

  • Abra la configuración del proyecto.

  • Vaya a la pestaña General.

  • Haga clic y arrastre el .framework al árbol del proyecto bajo la sección Frameworks, Libraries, etc.

• Cambie la configuración de BCCFinger.framework de Do not embed a Embed & Sign.

• Cambie la versión objetivo de su proyecto a un mínimo de iOS 13.

Se recomienda deshabilitar iPad como Target.

Configuración inicial

Esta versión no tiene dependencias en Firebase, ni desde una configuración inicial llamada por AppDelegate. La única configuración inicial necesaria es que la aplicación debe solicitar permiso de uso de la cámara. Para hacerlo, agregue la siguiente clave en el archivo info.plist, en Information Property List:

Privacy - Camera Usage Description

El valor de la clave es un mensaje que se mostrará al usuario al solicitar el permiso de uso de la cámara. Este valor puede estar en blanco o completarse con el mensaje deseado.

Uso

Parámetros y constructor

A continuación se muestra un ejemplo simple de uso de la biblioteca:

// Para inicializar una nueva captura
BCCFingerBuilder(self, delegate: self).initializeCapture()

La BCCFingerBuilder clase recibe los siguientes parámetros:

• hostVC: UIViewController - Controlador de vista que llama a la pantalla de captura.

• delegate: BCCFingerDelegate - Interfaz responsable de notificar eventos de captura (por ejemplo, falla o éxito).

La initialize método también acepta un parámetro opcional, como se muestra a continuación:

public func initializeCapture(
	_ navController: UINavigationController? = nil
) {
	// ...
}

Si desea que la navegación se realice a través de un navigation controller, debe proporcionarlo al llamar al método.

La BCCFingerBuilder clase es responsable de manejar la configuración de uso para BCCFinger. Los siguientes parámetros se aceptan para configurar la captura biométrica y el comportamiento del software:

• setSkipCaptureOption(_ enable: Bool) - Habilita la opción de omitir la captura actual.

• setDebugMode(_ enable: Bool) - Habilita el modo de depuración.

• buildCaptures(_ captures: BCCFingerCaptureType) - Define el tipo de captura de huellas dactilares. Las opciones son:

  public enum BCCFingerCaptureType {
  	case BOTH_HANDS
  	case ONLY_LEFT_HAND
  	case ONLY_RIGHT_HAND
  	case THUMBS
  	case LEFT_THUMB
  	case RIGHT_THUMB
  	case FULL_HANDS
  	case FULL_LEFT_HAND
  	case FULL_RIGHT_HAND
  }

  • BOTH_HANDS - Ambas manos sin pulgares.

  • ONLY_LEFT_HAND - Solo mano izquierda, sin pulgares.

  • ONLY_RIGHT_HAND - Solo mano derecha, sin pulgares.

  • THUMBS - Ambos pulgares.

  • LEFT_THUMB - Solo pulgar izquierdo.

  • RIGHT_THUMB - Solo pulgar derecho.

  • FULL_HANDS - Ambas manos con pulgares.

  • FULL_LEFT_HAND - Solo mano izquierda, con pulgares.

  • FULL_RIGHT_HAND - Solo mano derecha, con pulgares.

• buildBeginDelaySeconds(_ delay: Float) - Define el retraso para iniciar el ajuste automático del umbral.

• buildThreshold - Define los parámetros del umbral.

Como referencia, la lista completa de parámetros y valores predeterminados es:

var skipsHandOption: Bool = false
var debugMode: Bool = false
var capture: BCCFingerCaptureType = .FULL_HANDS
var beginDelaySeconds: Float = 1
var minQuality: Int = 20
var maxQuality: Int = 80
var totalTime: Double = 30
var stepCount: Int = 30

Valores de retorno

Los resultados de la última captura de huellas dactilares se pueden obtener a través del fingerCaptureDidFinish método de la interfaz BCCFingerDelegate :

func fingerCaptureDidFinish(
	_ returnData: BCCFingerReturnData,
	analytics: BCCFingerAnalytics
)

La returnData objeto contiene los siguientes métodos para la recuperación de datos:

• getCapturedFingersIndexes() - Devuelve una lista con el índice de todas las huellas dactilares capturadas:

  public enum FingerIndex: Int {
  	case leftLittle = 0
  	case leftRing = 1
  	case leftMiddle = 2
  	case leftIndex = 3
  	case leftThumb = 4
  	case rightThumb = 5
  	case rightIndex = 6
  	case rightMiddle = 7
  	case rightRing = 8
  	case rightLittle = 9
  }

• getCapturedFingers() - Devuelve un mapa que relaciona los índices de los dedos con las biometrías capturadas.

• getCapturedFingersData() - Devuelve la lista de todas las huellas dactilares capturadas:

  public var fingerprintPNG: UIImage
  public var wsqAsBase64: String

  • fingerprintPNG - Imagen PNG de la huella dactilar en escala de grises.

  • wsqAsBase64 - Imagen WSQ de la huella dactilar codificada en base64.

• getSkippedFingers() - Devuelve la lista de índices de todas las capturas de dedos omitidas.

La BCCFingerReturnData clase también contiene atributos que almacenan la información de la captura agrupada por mano:

public class BCCFingerReturnData {
	public let leftHand: HandData?
	public let rightHand: HandData?
}

Estos atributos pueden ser nulos cuando no se solicitan capturas para cualquiera de las manos.

La HandData clase contiene la siguiente información:

public internal(set) var capturedFingers: [FingerIndex : FingerData] = [:]
public internal(set) var skippedFingers: [FingerIndex] = []
public internal(set) var handsPhoto: UIImage? = nil
public internal(set) var thumbsPhoto: UIImage? = nil

• capturedFingers - Mapa que relaciona el índice del dedo con la imagen de la huella dactilar.

• skippedFingers - Lista de índices de todas las capturas de dedos omitidas.

• handsPhoto - Foto original de la mano de la cual se extrajeron las huellas dactilares.

• thumbPhoto - Foto original del pulgar.

Si el usuario aborta la captura, cerrando antes de capturar las biometrías, se llamará al método fingerCaptureDidAbort Se puede implementar este método para tratar este escenario.

Recuperación de imágenes originales

Es posible obtener las imágenes originales a través de la BCCFingerReturnData clase, como se muestra a continuación:

let leftSlapPhoto = returnData.leftHand?.handsPhoto
let rightSlapPhoto = returnData.rightHand?.handsPhoto
let leftThumbPhoto = returnData.leftHand?.thumbsPhoto
let rightThumbPhoto = returnData.rightHand?.handsPhoto

Proyecto de ejemplo

Este es un proyecto de ejemplo funcional para una captura de huellas dactilares utilizando BCC Mobile Finger iOS:

import UIKit
import FingerPhoto
import BCCFinger

class ViewController: UIViewController {

	override func viewDidLoad() {
		super.viewDidLoad()
	}

	@IBAction func startCaptureAction(_ sender: UIButton) {
		BCCFingerBuilder(self, delegate: self)
			.initializeCapture()
	}
}

extension ViewController: BCCFingerDelegate {

	func fingerCaptureDidFinish(
		_ returnData: BCCFinger.BCCFingerReturnData,
		analytics: BCCFinger.BCCFingerAnalytics
	) {
		// ...
	}

	func didAbortFingerCapture(
		analytics: BCCFinger.BCCFingerAnalytics
	) {
		// ...
	}

}