document-detector-ionic-nosentry v1.0.0

DocumentDetector - Ionic Plugin

Plugin que chama os SDKs nativos em Android e iOS. Caso tenha alguma dúvida, envie um email para o nosso Head of Mobile

Atualmente, os documentos suportados são RG, CNH, RNE e CRLV. Caso tenha alguma sugestão de outro documento, contate-nos!

Políticas de privacidade e termos e condições de uso

Ao utilizar nosso plugin, certifique-se que você concorda com nossas Políticas de privacidade e nossos Termos e condições de uso.

Configurações

Android

No arquivo ROOT_PROJECT/android/app/build.gradle, adicione:

android {

    ...

    dataBinding.enabled = true

    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }

    aaptOptions {
        noCompress "tflite"
    }
}

Importe o pacote e chame o método add() dentro da inicialização em android/app/src/main/java/io/ionic/starter/MainActivity.java:

import com.example.plugin.DocumentDetectorPlugin;

public class MainActivity extends BridgeActivity {
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    registerPlugin(DocumentDetectorPlugin.class);
  }
}

iOS

No arquivo ROOT_PROJECT/ios/App/Podfile, adicione no final do arquivo:

source 'https://github.com/combateafraude/iOS.git'
source 'https://cdn.cocoapods.org/' # ou 'https://github.com/CocoaPods/Specs' se o CDN estiver fora do ar

Por último, adicione a permissão de câmera no arquivo ROOT_PROJECT/ios/App/Runner/Info.plist:

<key>NSCameraUsageDescription</key>
<string>To read the documents</string>

Ionic

Adicione o plugin no seu arquivo ROOT_PROJECT/package.json:

"dependencies": {
    "document-detector-ionic": "https://github.com/combateafraude/Ionic/archive/refs/tags/document-detector-v6.6.0.tar.gz"
}

Após, execute: 1. npm install 2. ionic capacitor build < platform > options

Importando

import {DocumentDetector, DocumentDetectorStep, DocumentType} from 'document-detector-ionic';

Utilizando

    let documentDetector = new DocumentDetector();
    
    documentDetector.setMobileToken = '<your mobile token>';

    var documentDetectorSteps: Array<DocumentDetectorStep> = [
        new DocumentDetectorStep(DocumentType.RG_FRONT, null, null),
        new DocumentDetectorStep(DocumentType.RG_BACK, null, null)];

    documentDetector.setDocumentDetectorSteps = documentDetectorSteps;

    var response = await documentDetector.start();

    if(response.result == "SUCCESS"){
      // Sucesso
    }else if(response.result == "FAILURE"){
      // Falha. Confira reponse.type e response.message
    }else{
      // Usuário fechou a tela
    }

Customizações gerais

| ShowPreview | |Caso deseje personalizar os valores, crie uma String em ROOT_PROJECT/android/app/src/main/res/values/strings.xml com o nome e valor desejado e parametrize| | --------- | | bool showHabilita/Desabilita preview | | String titleTítulo | | String subTitleSubtítulo | | String confirmLabelTexto do botão de confirmação | | String retryLabelTexto do botão de capturar novamente |

Android

Exemplo de uso

   let documentDetector = new DocumentDetector();
   documentDetector.setAndroidSettings = new DocumentDetectorAndroidSettings({useEmulator: false, useDebug: true});

iOS

Coletando o resultado

O objeto de retorno do DocumentDetector terá o atributo result que contém uma string SUCCESS, FAILURE ou CLOSED. O retorno terá o padrão DocumentDetectorSuccess, DocumentDetectorFailure e DocumentDetectorClosed, respectivamente, para cada um dos casos.

DocumentDetectorSuccess

Capture

DocumentDtetectorFailure

Os tipos de falha existentes são:

• InvalidTokenReason: quando o token informado é inválido. Não deve ocorrer em um ambiente de produção;
• PermissionReason: quando alguma permissão obrigatória não foi concedida pelo usuário. Só ocorrerá em um ambiente de produção se o seu app não solicitar ao seu usuário ou o mesmo desabilitar manualmente antes de iniciar;
• NetworkReason: falha de conexão com o servidor. Ocorrerá em produção se o dispositivo do usuário estiver sem internet;
• ServerReason: falha em alguma requisição com nossos servidores. Ocorrerá em produção somente no caso de uma falha nossa;
• SecurityReason: quando o dispositivo não é seguro para executar o SDK. Se esta falha ocorrer, avise-nos;
• StorageReason: quando o dispositivo não possui espaço suficiente para a captura de alguma foto. Pode ocorrer em produção;
• LibraryReason: quando alguma falha interna impossibilitou a execução do SDK. Pode ocorrer devico à erros de configuração do projeto, não deve ocorrer em produção;

DocumentDetectorClosed

Objeto vazio indicando fechamento da tela de captura pelo usuário.