O construtor QiTechWebOCR.WebOCR()

Novidade na versão 4.0.0

A partir da versão 4.0.0, o construtor não recebe mais o htmlComponent como primeiro parâmetro — o SDK cria e gerencia seu próprio nó DOM internamente, adicionado ao document.body.

O método .WebOCR() é responsável pela configuração da instância do seu componente de documentoscopia. O construtor recebe dois parâmetros obrigatórios:

Parâmetro	Descrição	Obrigatório
webToken	Chave do cliente que identifica que os dados coletados são provenientes do seu aplicativo. Caso ainda não tenha recebido o seu web-token, entre em contato com o suporte.	Sim
sessionId	Utilizado para definir a chave que identifica a sessão iniciada no SDK. É usada para rastrear todo fluxo percorrido pelo usuário na execução da Web OCR através de logs. Este campo aceita uma string de até 255 caracteres. Deve ser único para cada sessão.	Sim

Após a instanciação, utilize os seguintes métodos encadeados para personalizar o comportamento:

Nome	Descrição	Obrigatório
.setThemeConfiguration(object)	Personaliza a identidade visual do SDK.	Não
.setShowInstructionScreen(boolean)	Exibe a tela de introdução com dicas de captura. Padrão: true.	Não
.setShowAllowedTemplatesScreen(boolean)	Exibe a tela que informa os documentos aceitos. Recomendamos ativá-la para que o usuário saiba quais documentos pode enviar.	Não
.setShowSuccessScreen(boolean)	Exibe a tela de sucesso ao final da captura. Padrão: true.	Não
.setSandboxEnvironment()	Configura o SDK para apontar para o ambiente de Sandbox.	Não

O método .setThemeConfiguration deve receber um objeto com os seguintes campos:

Nome	Tipo	Descrição
primaryColor	String	(recomendado) Hexadecimal da cor principal do SDK — usada em botões, ícones e elementos de destaque. Caso não seja informada, o padrão é #555555.
companyLogo	String	(recomendado) Caminho ou URL pública do logo da sua empresa (PNG). Caso não seja informado, será exibido um placeholder.
fontFamily	String	(recomendado) Nome da Font Family a ser configurada nos textos do SDK. Caso não seja informada, será utilizada a fonte padrão.

Compatibilidade

Os campos backgroundColor e buttonColor ainda são aceitos pelo método .setThemeConfiguration, mas são utilizados apenas como fallback para derivar o primaryColor quando este não for informado. Prefira usar primaryColor diretamente.

Versões Anteriores (< 4.0.0)

Nas versões anteriores, o construtor recebia o htmlComponent como primeiro parâmetro:

var htmlComponent = document.getElementById('webOCR');
var webOCR = new QiTechWebOCR.WebOCR(
    htmlComponent,
    "<WEB_TOKEN>",
    "<SESSION_ID>"
)