Este guía ha sido elaborada para ayudarlo a implementar el SDK Android de manera rápida y sencilla. A continuación, vea el paso a paso de todo el proceso de integración. Después de eso, si desea personalizar la experiencia, no deje de consultar la sección Personalización Android.

Marcos de documentos disponibles

En este modo de cámara, existe un marco de captura para ayudar al usuario a posicionar correctamente el documento. Después de posicionar el documento de manera correcta, el usuario debe hacer clic en el botón para realizar la captura de la foto del documento.

En este modo de cámara es posible capturar los documentos:

• CPF: Captura del frente del CPF;

• CNH: Captura de la CNH abierta;

• CNH frente: Captura del frente de la CNH;

• CNH verso: Captura del reverso de la CNH;

• RG frente: Captura del frente del RG;

• RG verso: Captura del reverso del RG;

• Otros: Captura de cualquier otro documento.

Inicializar el SDK

Cree una instancia del builder (Generado a través de la interfaz IAcessoBioBuilder), proporcionando como parámetro el contexto en cuestión y la implementación de la clase AcessoBioListener.

La implementación de esta clase es bastante simple y se puede hacer con pocas líneas de código. Todo lo que necesita hacer es instanciar el builder proporcionando el contexto correspondiente y sobrescribir los métodos de callback con las lógicas de negocio de su aplicación:

public class MainActivity extends AppCompatActivity {

    private AcessoBioListener callback = new AcessoBioListener() {
        @Override
        public void onErrorAcessoBio(ErrorBio errorBio) { }

        @Override
        public void onUserClosedCameraManually() { }

        @Override
        public void onSystemClosedCameraTimeoutSession() { }

        @Override
        public void onSystemChangedTypeCameraTimeoutFaceInference() { }
    };

    private IAcessoBioBuilder acessoBioBuilder = new AcessoBio(this, callback);
}

internal class MainActivity : AppCompatActivity() {

    private val callback = object : AcessoBioListener {
        override fun onErrorAcessoBio(errorBio: ErrorBio?) { }
    
        override fun onUserClosedCameraManually() { }
    
        override fun onSystemClosedCameraTimeoutSession() { }
    
        override fun onSystemChangedTypeCameraTimeoutFaceInference() { }
    }

    private val acessoBioBuilder: IAcessoBioBuilder = AcessoBio(this, callback)
}

Implementar las funciones de callback

Tenga en cuenta que el trabajo de implementación de la clase AcessoBioListener consiste en gran parte en la configuración de los métodos de callback. Cada método se llama en una situación específica de retorno del SDK.

Basta con sobrescribir los métodos ejemplificados en el paso anterior con las lógicas de negocio de su aplicación:

Implementar listeners para eventos de la cámara

El método de apertura de la cámara, que se llama en la siguiente etapa, necesita saber qué hacer cuando logre capturar una imagen con éxito o si ocurre algún error en el proceso. Es necesario especificar "qué hacer" al método de apertura de la cámara mediante la implementación de listeners que se llaman en situaciones de éxito o error.

A través de la configuración de los listeners, puede especificar qué ocurre en su App en situaciones de error (Método onErrorDocument) o éxito (Método onSuccessDocument) durante la captura de imágenes.

El siguiente ejemplo ilustra la configuración de los listeners, el build y la apertura de la cámara:

iAcessoBioDocument cameraListener = new iAcessoBioDocument() {
    @Override
    public void onSuccessDocument(ResultCamera result) { }

    @Override
    public void onErrorDocument(ErrorBio errorBio) { }
};

unicoCheckCamera.prepareDocumentCamera(unicoConfig, new DocumentCameraListener() {
    @Override
    public void onCameraReady(UnicoCheckCameraOpener.Document cameraOpener) {
        cameraOpener.open(DocumentType.CNH, cameraListener);
    }

    @Override
    public void onCameraFailed(String message) {
        Log.e(TAG, message);
    }
});

val cameraListener: iAcessoBioDocument = object : iAcessoBioDocument {
    override fun onSuccessDocument(result: ResultCamera?) {}

    override fun onErrorDocument(errorBio: ErrorBio?) {}
}

unicoCheckCamera.prepareDocumentCamera(unicoConfig, object : DocumentCameraListener {
    override fun onCameraReady(cameraOpener: UnicoCheckCameraOpener.Document?) {
        cameraOpener?.open(DocumentType.CNH, cameraListener)
    }

    override fun onCameraFailed(message: String?) {
        Log.e(TAG, message)
    }
})

Preparar y abrir la cámara

Es necesario crear una instancia del builder a través del método build(). Este método está disponible a través del objeto generado con la interfaz IAcessoBioBuilder y la clase AcessoBio:

UnicoCheckCamera unicoCheckCamera = acessoBioBuilder.build();  

val unicoCheckCamera = acessoBioBuilder.build()

El siguiente paso es preparar la cámara utilizando el método prepareDocumentCamera() con el objeto retornado por el builder (nombrado como UnicoCheckCamera en el ejemplo anterior).

El método prepareDocumentCamera() genera un objeto del tipo UnicoCheckCameraOpener.Document, que se utiliza para abrir la cámara con su método open(), recibiendo los parámetros del tipo de documento a capturar, siendo estos:

Método onSuccessDocument

Al realizar una captura de imagen con éxito, este método es invocado y retorna un objeto del tipo ResultCamera, que se utiliza posteriormente en la llamada a las APIs REST:

public void onSuccessDocument(ResultCamera result) { }

El objeto ResultCamera retorna 2 atributos: base64 y encrypted:

• El atributo base64 puede ser utilizado si desea mostrar una vista previa de la imagen en su app.

• Tanto el atributo encrypted como el atributo base64 pueden enviarse en la llamada a las APIs REST.

Método onErrorDocument

Cuando ocurre un error en la captura de imagen, este método es invocado y retorna un objeto del tipo ErrorBio:

public void onErrorDocument(ErrorBio errorBio) { }

Realizar una solicitud POST en la API REST

La captura de las imágenes es solo la primera parte del proceso. Después de capturar la imagen, es necesario enviar el base64 generado por el SDK a las APIs REST. Infórmese más en la sección Creación de proceso.

¿Dudas?

¿No encontraste algo o aún necesitas ayuda? Si ya eres cliente o socio, puedes ponerte en contacto a través del Centro de Ayuda.

Este guía fue elaborada para ayudarlo a implementar el SDK Android de manera rápida y sencilla. A continuación, vea el paso a paso de todo el proceso de integración. Después de eso, si desea personalizar la experiencia, no deje de ver la sección Personalización Android.

Inicializar el SDK

Cree una instancia del builder (Generado a través de la interfaz IAcessoBioBuilder), proporcionando como parámetro el contexto y el ambiente en cuestión, y la implementación de la clase AcessoBioListener.

La implementación de esta clase es muy simple y se puede hacer con pocas líneas de código. Lo único que necesita hacer es instanciar el builder proporcionando el contexto correspondiente y sobrescribir los métodos de callback con la lógica de negocio de su aplicación:

public class MainActivity extends AppCompatActivity {

    private AcessoBioListener callback = new AcessoBioListener() {
        @Override
        public void onErrorAcessoBio(ErrorBio errorBio) { }

        @Override
        public void onUserClosedCameraManually() { }

        @Override
        public void onSystemClosedCameraTimeoutSession() { }

        @Override
        public void onSystemChangedTypeCameraTimeoutFaceInference() { }
    };

    private IAcessoBioBuilder acessoBioBuilder = new AcessoBio(this, callback);
}

internal class MainActivity : AppCompatActivity() {

    private val callback = object : AcessoBioListener {
        override fun onErrorAcessoBio(errorBio: ErrorBio?) { }
    
        override fun onUserClosedCameraManually() { }
    
        override fun onSystemClosedCameraTimeoutSession() { }
    
        override fun onSystemChangedTypeCameraTimeoutFaceInference() { }
    }

    private val acessoBioBuilder: IAcessoBioBuilder = AcessoBio(this, callback)
}

Configuración de ambientes

Configure el ambiente que se utilizará en la ejecución del SDK. Utilice el enumerado Environment que contiene los siguientes valores enumerados:

• Environment.PROD: para ambiente de Producción;

• Environment.UAT: para ambiente de Homologación.

Vea cómo implementarlo en el siguiente ejemplo:

acessoBioBuilder.setEnvironment(Environment.UAT);

acessoBioBuilder.setEnvironment(Environment.UAT);

Implementar las funciones de callback

Tenga en cuenta que el trabajo de implementación de la clase AcessoBioListener es, en su mayoría, la configuración de los métodos de callback. Cada método se llama en una situación específica de retorno del SDK.

Basta con sobrescribir los métodos ejemplificados en el paso anterior con la lógica de negocio de su aplicación.

Este método se invoca siempre que ocurra cualquier error de implementación al utilizar alguno de nuestros métodos:

Configurar modo de cámara

El SDK tiene configurado y habilitado por defecto el encuadre inteligente y la captura automática. Por lo tanto, debe configurarse el modo de cámara en su builder de la siguiente manera:

UnicoCheckCamera unicoCheckCamera = acessoBioBuilder
    .setAutoCapture(true)
    .setSmartFrame(true)
    .build();

val unicoCheckCamera: UnicoCheckCamera = acessoBioBuilder
    .setAutoCapture(true)
    .setSmartFrame(true)
    .build()

Implementar listeners para eventos de la cámara

El método de apertura de la cámara, que se llama en la siguiente etapa, necesita saber qué hacer al lograr capturar una imagen con éxito o si ocurre algún error en el proceso. Es necesario especificar "qué hacer" al método de apertura de la cámara mediante la implementación de listeners que se llaman en situaciones de éxito o error.

A través de la configuración de los listeners, puede especificar qué sucede en su App en situaciones de error (Método onErrorSelfie) o éxito (Método onSuccessSelfie) durante la captura de imágenes.

Para la configuración de los listeners, es necesario implementar:

iAcessoBioSelfie cameraListener = new iAcessoBioSelfie() {
    @Override
    public void onSuccessSelfie(ResultCamera result) { }

    @Override
    public void onErrorSelfie(ErrorBio errorBio) { }
};

unicoCheckCamera.prepareCamera(unicoConfig, new CameraListener() {
    @Override
    public void onCameraReady(UnicoCheckCameraOpener.Camera cameraOpener) {
        cameraOpener.open(cameraListener);
    }

    @Override
    public void onCameraFailed(String message) {
        Log.e(TAG, message);
    }
});

val cameraListener: iAcessoBioSelfie = object : iAcessoBioSelfie {
    override fun onSuccessSelfie(result: ResultCamera?) {}

    override fun onErrorSelfie(errorBio: ErrorBio?) {}
}

unicoCheckCamera.prepareCamera(unicoConfig, object : CameraListener {
    override fun onCameraReady(cameraOpener: UnicoCheckCameraOpener.Camera?) {
        cameraOpener?.open(cameraListener)
    }

    override fun onCameraFailed(message: String?) {
        Log.e(TAG, message)
    }
})

Preparar y abrir cámara

Para continuar con la apertura de la cámara, primero es necesario prepararla utilizando el método prepareCamera. Este método recibe como parámetro la implementación de la clase CameraListener, la clase o el JSON con las credenciales, generados en esta etapa.

Cuando la cámara esté preparada, se dispara el evento onCameraReady, que recibe como parámetro un objeto del tipo UnicoCheckCameraOpener.Camera.

Es necesario sobrescribir este método, realizando la apertura de la cámara con el objeto recibido a través del método open(). El método open() debe recibir como parámetro los listeners configurados en los pasos anteriores.

Método onSuccessSelfie

Al realizar una captura de imagen con éxito, este método es invocado y retorna un objeto del tipo ResultCamera, que se utiliza posteriormente en la llamada a las APIs REST:

public void onSuccessSelfie(ResultCamera result) { }

El objeto ResultCamera retorna 2 atributos: base64 y encrypted:

• El atributo base64 puede ser utilizado si se desea mostrar una vista previa de la imagen en su app.

• El atributo encrypted debe ser enviado en la llamada a las APIs REST del IDCloud.

Método onErrorSelfie

Cuando ocurre algún error en la captura de imagen, este método es invocado y retorna un objeto del tipo ErrorBio:

public void onErrorSelfie(ErrorBio errorBio) { }

Realizar una solicitud POST en la API REST

La captura de las imágenes es solo la primera parte del proceso. Después de capturar la imagen, es necesario enviar el encrypted generado por el SDK a las APIs REST. Infórmese más en la sección Creación de proceso.

¿Dudas?

¿No encontraste algo o aún necesitas ayuda? Si ya eres cliente o socio, puedes ponerte en contacto a través del Centro de Ayuda.