Pular para o conteúdo principal

Introdução

Bem vindo ao manual de integração do SDK de OCR (Optical Character Recognition) da QI Tech em React Native! O módulo @qitech/react-native-caas expõe, por meio de uma interface TypeScript, os SDKs nativos de Android (Java/Kotlin) e iOS (Swift) da QI Tech. Você pode utilizá-lo para capturar através do seu aplicativo uma imagem de um documento de seu cliente a ser reconhecido, como uma Carteira de Habilitação ou Cédula de identidade, e referenciá-lo através de uma chave nos demais produtos do sistema QI Tech.

Pacotes disponíveis

PacoteConteúdoQuando usar
@qitech/react-native-caasReconhecimento facial, OCR e Scan de dispositivoQuando você precisa de OCR, reconhecimento facial ou do fluxo completo de onboarding.
@qitech/react-native-device-scanSomente Scan de dispositivoQuando você precisa apenas de scan de dispositivo — instalação mais leve, com menos dependências nativas.
Aviso Importante!

Ambos os pacotes incluem o Scan de dispositivo. Não instale os dois — escolha apenas um.

Para o OCR, utilize o @qitech/react-native-caas.

Problemas?

Nós não somos uma companhia que se esconde atrás de uma API! Entre em contato com o nosso suporte e nós responderemos o mais rápido possível. Fique à vontade para nos ligar caso deseje uma resposta rápida!

Adoramos Feedback

Mesmo que você já tenha resolvido o seu problema ou que ele seja muito simples (Até mesmo um typo ou uma organização inadequada que você já entendeu), envie-nos um e-mail, assim nós tornamos a documentação cada vez mais prática e a próxima pessoa não vai precisar sofrer as dores que você sofreu!

Ambientes

Possuímos dois ambientes para os nossos clientes. A seleção é realizada por meio do enumerador CAAS_ENVIRONMENT, repassado como primeiro parâmetro da função startOcr. No momento, os seguintes ambientes estão disponíveis:

  • Produção - CAAS_ENVIRONMENT.PRODUCTION
  • Sandbox - CAAS_ENVIRONMENT.SANDBOX

Cada ambiente exige um Mobile Token diferente.

Aviso Importante!

Não devem ser usados dados reais de pessoas físicas e/ou jurídicas nos ambientes de Sandbox da QI Tech.

Próximos passos

  1. Compatibilidade — versões mínimas de React Native, iOS e Android.
  2. Instalação — instalação do pacote e configuração nativa de Android, iOS e Expo.
  3. Implementação — exemplo completo da chamada startOcr.
  4. O objeto OcrOptions — todos os parâmetros de customização.
  5. Coletando os Retornos — estrutura de resposta e tratamento de erros.