Guia de uso e integração

Inicializar o SDK

Crie uma instância do builder (Gerado através da interface IAcessoBioBuilder), fornecendo como parâmetro o contexto e ambiente em questão e a implementação da classe AcessoBioListener.

A implementação dessa classe é bem simples e pode ser feita com poucas linhas de código. Tudo que precisa fazer é instanciar o builder informando o contexto em questão e sobrescrever os métodos da interface AcessoBioListener com as lógicas de negócio de sua aplicação:

Kotlin

internal class MainActivity : AppCompatActivity() {

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

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

Java

Configuração de ambientes

Configure o ambiente que será utilizado na execução da SDK. Utilize o enumerado Environment que contém os seguintes enumerados:

• Environment.PROD: para ambiente de Produção;

• Environment.UAT: para ambiente de Homologação.

Veja como implementar no exemplo abaixo:

Kotlin

acessoBioBuilder.setEnvironment(Environment.UAT)

Java

Implementar as funções do listener

Note que, o trabalho de implementação da classe AcessoBioListener é, em grande parte, a configuração de seus métodos. Cada método é chamado em uma situação específica de retorno do SDK.

Basta sobrescrever os métodos exemplificados no passo anterior com as lógicas de negócio de sua aplicação.

Este método é invocado sempre que qualquer erro de implementação ocorrer ao utilizar algum de nossos métodos:

1

onErrorAcessoBio(ErrorBio errorBio)

Ao ser invocado, o método recebe um parâmetro do tipo ErrorBio que contem detalhes do erro. Saiba mais sobre o tipo ErrorBio na seção de tratamento de erros.

2

onUserClosedCameraManually()

Este método é invocado sempre quando o usuário fechar a câmera de forma manual, como por exemplo, ao clicar no botão "Voltar".

3

onSystemClosedCameraTimeoutSession()

Este método é invocado assim que o tempo máximo de sessão for atingido (Sem capturar nenhuma imagem).

Pode ser configurado no builder através do método setTimeoutSession. Este método deve receber o tempo máximo da sessão em segundos. É possível alterar o tempo máximo de sessão do seu usuário ao utilizar a funcionalidade de detecção do rosto (Câmera de selfie com captura inteligente). Caso ele ultrapasse o tempo determinado em seu processo para capturar a foto, você pode apresentar alguma mensagem personalizável ou instrução ao usuário. O valor padrão é de 40 segundos e seu valor mínimo também é de 40 segundos.

4

onSystemChangedTypeCameraTimeoutFaceInference()

Este método é invocado assim que o tempo máximo para detecção do rosto de um usuário for atingido (Sem ter nada detectado). Neste caso, o modo de câmera é alterado automaticamente para o modo de captura manual (Sem a silhueta de captura inteligente).

O tempo máximo de captura ao utilizar a detecção do rosto (Câmera de selfie com captura inteligente) é de 13 segundos. Se o usuário encontra alguma dificuldade para captura da foto através da detecção do rosto e ultrapasse o tempo determinado em seu processo, a captura é alterada automaticamente para a manual, tendo como objetivo facilitar a ação para o usuário (TimeoutToFaceInference).

Todos os métodos acima devem ser criados da forma indicada em seu projeto (Mesmo que sem nenhuma lógica). Caso contrário, o projeto não compila com sucesso.

Kotlin

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

Java

Implementar listeners para eventos da câmera

A implementação destes métodos listeners deve ser feita através de uma instância da classe iAcessoBioSelfie.

O método de abertura da câmera, que é chamado na próxima etapa, precisa saber o que fazer ao conseguir capturar uma imagem com sucesso ou ao ocorrer algum erro no processo. É necessário informar "o que fazer" ao método de abertura da câmera através da implantação de listeners que são chamados em situações de sucesso ou erro.

Através da configuração dos listeners, você pode especificar o que acontece em seu App em situações de erro (Método onErrorSelfie) ou sucesso (Método onSuccessSelfie) na captura de imagens.

Para a configuração dos listeners, é necessário implementar:

Kotlin

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

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

Java

Preparar e abrir câmera

Para seguir com a abertura da câmera, primeiro é necessário prepará-la utilizando o método prepareCamera. Este método recebe como parâmetro a implementação da classe CameraListener, a classe ou o JSON com as credenciais, gerado nessa etapa.

Quando a câmera estiver preparada, é disparado o evento onCameraReady, que recebe como parâmetro um objeto do tipo UnicoCheckCameraOpener.Camera.

É necessário sobrescrever este método, efetuando a abertura da câmera com o objeto recebido através do método open(). O método open() deve receber como parâmetro os listeners configurados nos passos acima.

Como temos dois fluxos de integração (um nativo e um via webApp), existe uma diferenciação no método usado como gatilho para iniciar o fluxo de captura.

Para integração com o fluxo em webApp, a implementação é a seguinte:

Kotlin

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

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

Java

O web_app_token é um parâmetro de mesmo nome que é retornado no response ao criar um processo no by Unico.

Método onSucessSelfie

Este método é de implementação obrigatória, visto que a interface é utilizada na integração by Client. No contexto by Unico, ele não retorna o resultado da operação diretamente; portanto, é necessário utilizar o método onSuccess, detalhado abaixo.

Ao efetuar uma captura de imagem com sucesso, este método é invocado e retorna um objeto do tipo ResultCamera que é utilizado posteriormente na chamada das APIs REST:

Kotlin

override fun onSuccessSelfie(result: ResultCamera?) {}

Java

O objeto SuccessResult retorna 1 atributo: processId:

• O atributo processId pode ser utilizado para obter informações sobre o processo anteriormente criado.

Método onSucess

Ele é um método com valor default já definido, sendo obrigatória a implementação apenas em caso de sua integração ser via IDCloud One.

Ao finalizar o fluxo no WebApp com sucesso, este método é invocado e retorna um objeto do tipo SuccessResult que é utilizado posteriormente na chamada das APIs REST:

Kotlin

override fun onSuccess(result: SuccessResult) {}

Java

O objeto SuccessResult retorna 1 atributo: processId

• O atributo processId pode ser utilizado para consultar o resultado do processo de validação do cliente.

Método onErrorSelfie

Ao ocorrer algum erro na captura de imagem, este método é invocado e retorna um objeto do tipo ErrorBio:

Kotlin

override fun onErrorSelfie(errorBio: ErrorBio?) {}

Java