DocumentDetector v7.x e superior
Requisitos
Flutter
1.20+
Dart
>=2.15.0 <4.0.0
minSdk
26
compileSdk
34
Alvo do iOS
13.0+
Xcode
15.4+
Swift
5.3.2+
Dependências dos SDKs nativos
dependencies {
// Básico
implementation "androidx.appcompat:appcompat:1.1.0"
// Design
implementation "com.google.android.material:material:1.2.1"
implementation "androidx.constraintlayout:constraintlayout:2.0.1"
// Detecção de documentos
implementation "org.tensorflow:tensorflow-lite:2.11.0"
implementation "org.tensorflow:tensorflow-lite-support:0.4.3"
// SecurityProvider
implementation "com.google.android.gms:play-services-basement:18.3.0"
// HTTP e desserializador
implementation "com.squareup.retrofit2:retrofit:2.9.0"
implementation "com.squareup.retrofit2:converter-gson:2.9.0"
implementation "com.squareup.okhttp3:okhttp:4.9.3"
implementation "com.squareup.okhttp3:okhttp-tls:4.9.3"
//exifInterface
implementation "androidx.exifinterface:exifinterface:1.0.0"
// Biblioteca principal CameraX usando a implementação camera2
// A linha a seguir é opcional, pois a biblioteca principal é incluída indiretamente por camera-camera2
implementation "androidx.camera:camera-core:1.1.0"
implementation "androidx.camera:camera-camera2:1.1.0"
// Se você quiser usar adicionalmente a biblioteca CameraX Lifecycle
implementation "androidx.camera:camera-lifecycle:1.1.0"
// Se você quiser usar adicionalmente a classe View do CameraX
implementation "androidx.camera:camera-view:1.1.0"
// Verificações de root
implementation "com.scottyab:rootbeer-lib:0.0.8"
// Commons Imaging (para imagens, dados EXIF e assim por diante. anteriormente conhecido como Apache Commons Sanselan)
implementation "org.apache.commons:commons-imaging:1.0-alpha3"
// Kotlin
implementation "androidx.core:core-ktx:1.7.0"
implementation "org.jetbrains.kotlin:kotlin-stdlib:1.5.31"
}
Permissões em tempo de execução
Estas são as permissões de tempo de execução do Android:
CÂMERA
Para capturar fotos dos documentos
Necessário apenas no fluxo de captura pela câmera
READ_EXTERNAL_STORAGE
Para acessar o armazenamento externo do dispositivo e selecionar documentos no fluxo de upload. Esta permissão é necessária apenas para versões inferiores à API33
Necessário apenas no fluxo de envio
Estas são as permissões de tempo de execução do iOS:
Privacidade - Descrição de Uso da Câmera
Para capturar a(s) foto(s) do documento
Necessário apenas no fluxo de captura pela câmera
Privacidade - Descrição de Uso da Biblioteca de Fotos
Para realizar a abertura da galeria
Necessário apenas no fluxo de envio
Configurações da plataforma
Se a sua versão do Gradle for anterior à 7, adicione estas linhas ao seu build.gradle.
Se a sua versão do Gradle for 7 ou mais recente, adicione estas linhas ao seu settings.gradle.
Adicione suporte ao Java 8 (ignore este código se o Java 8 estiver habilitado) e ao TensorFlow Model ao seu build.gradle arquivo.
Para personalizar a cor principal do SDK, você precisa garantir que a biblioteca Material Design esteja importada no seu app. Adicione a seguinte dependência ao seu arquivo build.gradle:
No info.plist arquivo, adicione as permissões abaixo:
Privacidade - Descrição de Uso da Câmera
Para capturar a(s) foto(s) do documento
Necessário apenas no fluxo de captura pela câmera
Privacidade - Descrição de Uso da Biblioteca de Fotos
Para realizar a abertura da galeria
Necessário apenas no fluxo de envio
Documentos suportados
Atualmente, os documentos suportados são:
Instanciando o SDK
Para criar uma DocumentDetector instância, dois parâmetros obrigatórios devem ser fornecidos:
mobileToken
Token de uso associado à sua conta CAF
captureFlow
Define o fluxo de captura do documento. Crie uma List<DocumentCaptureFlow> para configurar cada etapa de captura.
DocumentCaptureFlow
Cada DocumentCaptureFlow elemento da lista será uma etapa de captura.
O DocumentCaptureFlow a classe tem as seguintes configurações:
DocumentType documentType
Identifica qual documento será solicitado para captura na respectiva etapa. Você pode escolher na Documentos suportados lista.
InstructionalPopupSettingsAndroid? androidCustomization
Personalize a ilustração e o rótulo do documento no popup instrucional para dispositivos Android.
String? documentLabel
Altere o rótulo do documento exibido no popup. Para personalizar isso, basta fornecer um String elemento.
String? documentIllustration
Altere a ilustração do documento exibida no popup. Para personalizar isso, você deve fornecer o nome do arquivo com a ilustração personalizada que você criou na res/drawable pasta do seu app Android.
InstructionalPopupSettingsIOS? iOSCustomization
Personalize a ilustração e o rótulo do documento no popup instrucional para dispositivos iOS.
String? documentLabel
Altere o rótulo do documento exibido no popup. Para personalizar isso, você só precisa fornecer um String elemento.
String? documentIllustration
Altere a ilustração do documento exibida no popup. Para personalizar isso, você deve fornecer o nome do Image Set com a ilustração personalizada que você criou no Asset Catalog do seu app iOS.
Exemplo de implementação
Este é um exemplo de como instanciar o SDK e capturar seus resultados:
Opções do DocumentDetector
Resultados do DocumentDetectorEvent
DocumentDetectorEvent é uma classe abstrata que representa diferentes tipos de eventos.
É usada para criar uma instância de uma das subclasses de evento com base em uma entrada de mapa, que vem do resultado do SDK.
Dependendo do tipo de evento, cria uma instância de DocumentDetectorEventClosed, DocumentDetectorEventSuccess, ou DocumentDetectorEventFailure. Se o evento não for reconhecido, lança uma exceção interna.
Essa configuração permite uma forma estruturada e segura em relação a tipos para lidar com diferentes resultados do processo de captura de documento no SDK.
DocumentDetectorEventClosed
Esta classe representa um evento em que a captura do documento foi encerrada pelo usuário, seja ao pressionar o botão de fechar no canto superior direito ou ao enviar o app para segundo plano.
DocumentDetectorEventSuccess
Esta classe representa um evento de captura de documento bem-sucedido. O documento do usuário foi capturado com sucesso, e as URLs para download das capturas foram retornadas. Inclui:
String? documentType
O tipo do documento capturado
String? trackingId
Um ID para rastrear a execução da captura.
DocumentDetectorEventFailure
Esta classe representa uma falha no processo de captura de documento. O documento do usuário não foi capturado com sucesso, o errorType e errorMessage parâmetro contém o motivo da falha. Inclui:
String? errorType
Informações sobre o tipo de erro retornado pelo SDK. Abaixo estão os tipos de erro e suas causas:
AvailabilityReason
O SDK ainda não está disponível para uso. O errorMessage parâmetro trará mais instruções.
O armazenamento interno do dispositivo está cheio ao instalar o app, e o modelo de detecção facial não pode ser instalado junto.
InvalidTokenReason
O token informado não é válido para o produto correspondente.
Se você estiver usando um token expirado ou inexistente.
LibraryReason
Quando uma biblioteca interna do SDK não pode ser iniciada.
Esquecer de definir o aaptOptions noCompress configuração causará essa falha no DocumentDetector.
NetworkReason
Falha na conexão com a internet.
O usuário estava sem internet durante a execução do SDK.
PermissionReason
Está faltando alguma permissão obrigatória para executar o SDK.
Iniciar o SDK sem a permissão da câmera concedida.
SecurityReason
Quando o SDK não pode ser iniciado por um motivo de segurança.
Quando o dispositivo está com root. Consulte código de erro de segurança para mais motivos.
ServerReason
Quando uma solicitação do SDK recebe um código de status de falha.
Se uma API interna estiver instável.
StorageReason
Não há espaço no armazenamento interno do dispositivo do usuário.
Quando não há espaço no armazenamento interno durante a captura da foto do documento.
InvalidTokenReason
O token informado não é válido para o produto correspondente.
Se você estiver usando um token expirado ou inexistente.
NetworkReason
Falha na conexão com a internet.
O usuário estava sem internet durante a execução do SDK.
PermissionReason
Está faltando alguma permissão obrigatória para executar o SDK.
Iniciar o SDK sem a permissão da câmera concedida.
ServerReason
Quando uma solicitação do SDK recebe um código de status de falha.
Se uma API interna estiver instável.
StorageReason
Não há espaço no armazenamento interno do dispositivo do usuário.
Quando não há espaço no armazenamento interno durante a captura da foto do documento.
String? errorMessage
Uma mensagem que descreve o erro.
int? securityErrorCode
Um código de erro específico do Android, indicando o tipo de falha na validação de segurança:
100- bloqueando dispositivos emulados;200- bloqueando dispositivos com root;300- bloqueando dispositivos com opções de desenvolvedor ativadas;400- bloqueando dispositivos com ADB ativado;500- bloqueando dispositivos com depuração ativada;
Atualizado

