Pular para o conteúdo principal

O construtor QiTechWebOCR.WebOCR()

O método .WebOCR é responsável pela configuração da instância do seu componente de documentoscopia. Este método apresenta as seguintes configurações.

NomeDescriçãoObrigatório
htmlComponentComponente HTML pai que vai abrigar o HTML da SDK.Sim
webTokenChave 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
sessionIdUtilizado para definir a chave que identifica a sessão iniciada na 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
.setThemeConfiguration(object)Método utilizado para personalizar a identidade visual dos componentes do elemento WebOCR.Não
.setShowInstructionScreen(boolean)Método utilizado para renderizar a tela de introdução com dicas para captura do documento selecionado. Recebe true ou false. Caso não seja utilizada, o padrão é true.Não
.setShowSuccessScreen(boolean)Método utilizado para renderizar a tela de sucesso ao final do processo de captura. Recebe true ou false. Caso não seja utilizada, o padrão é true.Não
.setSandboxEnvironment()Método utilizado para configurar o ambiente para modo Sandbox. Caso não seja utilizada, o padrão é Production.Não

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

nometipodescrição
companyLogoString(recomendado) Caminho ou URL pública do asset do logo da sua empresa (PNG). Caso não seja informado, o padrão é um placeholder.
buttonColorString(recomendado) Hexadecimal da cor dos botões da tela. Caso não seja informada, o padrão é #1C49AD.
fontColorString(recomendado) Hexadecimal da cor dos textos mostrados na tela. Caso não seja informada, o padrão é #FCFCFC.
backgroundColorString(recomendado) Hexadecimal da cor de fundo da tela. Caso não seja informada, o padrão é #1C49AD.
fontFamilyString(recomendado) Nome da Font Family a ser configurada nos textos da SDK. Caso não seja informada, será configurada uma fonte padrão.