Este guia foi elaborado para ajudá-lo a implementar o SDK Flutter de forma rápida e fácil. Abaixo veja o passo a passo de todo o processo de integração. Após isso, caso deseje personalizar a experiência, não deixe de ver a seção Personalização Flutter.

Frames de documentos disponíveis

Neste modo de câmera, existe um frame de captura para auxiliar o usuário a posicionar o documento corretamente. Após posicionar o documento corretamente, o usuário deve clicar no botão para realizar a captura da foto do documento.

Neste modo de câmera é possivel capturar os documentos:

• CPF: Captura da frente do CPF;

• CNH: Captura da CNH aberta;

• CNH frente: Captura da frente da CNH;

• CNH verso: Captura do verso da CNH;

• RG frente: Captura da frente do RG;

• RG verso: Captura do verso do RG;

• Outros: Captura de qualquer outro documento.

Inicializar o SDK

Para iniciar, crie uma instância do builder (gerado através da interface UnicoCheckBuilder, fornecendo como parâmetro o contexto em questão e a implementação da classe UnicoListener.

A implementação dessa classe é bem simples e pode ser feita com poucas linhas de código. Tudo que precisa fazer é sobrescrever os métodos de callback com as lógicas de negócio de sua aplicação.

class _MyHomePageState extends State<MyHomePage> implements UnicoListener {

    late UnicoCheckBuilder _unicoCheck;

    /// Unico callbacks
      @override
      void onErrorUnico(UnicoError error) {}

      @override
      void onUserClosedCameraManually() {}

      @override
      void onSystemChangedTypeCameraTimeoutFaceInference() {}

      @override
      void onSystemClosedCameraTimeoutSession() {}

      /// Document callbacks
      @override
      void onSuccessDocument(ResultCamera resultCamera) { }

      @override
      void onErrorDocument(UnicoError error) { }

}

Implementar as funções de callback

Note que, conforme o exemplo anterior, o trabalho de implementação da classe UnicoListener é, em grande parte, a configuração dos métodos de callback. 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:

Implementar listeners para eventos da câmera

O método de abertura da câmera precisa saber o que fazer ao conseguir capturar uma imagem ou ao ter algum erro no processo. É informado "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 implementação dos listeners, você pode especificar o que acontece em seu App em situações de erro (método onErrorDocument) ou sucesso (método onSuccessDocument) na captura de imagens.

Método onSucessDocument

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:

public void onSuccessDocument(ResultCamera resultCamera) { }

O objeto ResultCamera retorna 2 atributos: base64 e encrypted:

• O atributo base64 pode ser utilizado se quiser exibir uma prévia da imagem em seu app;

• Tanto o atributo encrypted quanto o atributo base64 podem ser enviados na chamada das APIs REST do by Client.

Método onErrorDocument

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

public void onErrorDocument(UnicoError error) { }

Preparar e abrir câmera

Para abrir a câmera, o método openCameraDocument() é utilizado. Esse método é disponibilizado através do objeto gerado com uma instancia da classe UnicoCheck.

Este método recebe os seguintes parâmetros:

• Arquivo JSON com as credenciais, gerado no passo de configurar credenciais;

• Os listeners configurados acima;

• Tipo de documento a ser capturado, sendo eles:

Exemplo para captura de CNH:

 _unicoCheck.build().openCameraDocument(
        jsonFileName: androidJsonFileName,
        documentType: DocumentType.CNH,
        listener: this);

Realize um requisição POST na API REST do by Client

A captura das imagens é apenas a primeira parte da jornada. Após capturar a imagem, é necessário enviar o base64 gerado pelo SDK para as APIs REST do by Client. Saiba mais na seção CreateProcess do by Client.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Este guia foi elaborado para ajudá-lo a implementar o SDK Flutter de forma rápida e fácil. Abaixo veja o passo a passo de todo o processo de integração. Após isso, caso deseje personalizar a experiência, não deixe de ver a seção .

Inicializar o SDK

Para iniciar, crie uma instância do builder (gerado através da interface UnicoCheckBuilder, fornecendo como parâmetro o contexto e ambiente em questão e a implementação da classe UnicoListener.

A implementação dessa classe é bem simples e pode ser feita com poucas linhas de código. Tudo que precisa fazer é sobrescrever os métodos de callback com as lógicas de negócio de sua aplicação.

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:

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

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

Veja como implementar no exemplo abaixo:

Implementar as funções de callback

Note que, conforme o exemplo anterior, o trabalho de implementação da classe UnicoListener é, em grande parte, a configuração dos métodos de callback. Cada método será 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:

Configurar modo de câmera

O SDK tem configurado e habilitado por padrão o enquadramento inteligente e a captura automática. Em função disso, deve-se configurar o modo de câmera no seu builder da seguinte forma:

Implementar listeners para eventos da câmera

O método de abertura da câmera precisa saber o que fazer ao conseguir capturar uma imagem ou ao ter algum erro no processo. É informado "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 implementaçã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.

Método onSucessSelfie

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:

O objeto ResultCamera retorna 2 atributos: base64 e encrypted:

• O atributo base64 pode ser utilizado se quiser exibir uma prévia da imagem em seu app;

Método onErrorSelfie

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

Preparar e abrir câmera

O método openCameraSelfie é utilizado para abrir a camera. Este método recebe como parâmetro a implementação da classe UnicoSelfie e o JSON com as credenciais, gerado na etapa acima.

O exemplo a seguir ilustra os passos de configuração dos listeners e abertura da câmera:

Realize um requisição POST na API REST do by Client