Skip to main content

Implementação

<script>
var htmlComponent = document.getElementById('webOCR')
var webOCR = new QiTechWebOCR.WebOCR(
htmlComponent,
"<WEB_TOKEN>",
"<SESSION_ID>"
)
.setThemeConfiguration(
{
"companyLogo": "<PATH_OR_URL_TO_YOUR_COMPANY_LOGO>",
"backgroundColor": "<BACKGROUND_COLOR_HEX>",
"fontColor": "<FONT_COLOR_HEX>",
"buttonColor": "<BUTTON_COLOR_HEX>",
"fontFamily": "<FONT_FAMILY>"
}
)
.setShowInstructionScreen(true)
.setShowSuccessScreen(true)
.setSandboxEnvironment()
.build()

function initOCR(document_type) {
webOCR.initialize(document_type)
.then((ocr_key) => {
console.log(ocr_key)
})
.catch((error) => {
console.log(error)
})
}
</script>

A inicialização da Web OCR SDK é realizada através da chamada da função .initialize(), que pertence a classe WebOCR e que está contida em nossa biblioteca QiTechWebOCR, conforme o exemplo acima. A classe WebOCR deve ser instânciada passando 3 parâmetros obrigatórios para seu construtor, sendo estes o htmlComponent, o webToken e o sessionId (nessa exata ordem). Além dos parâmetros, também é recomendada a utilização de algumas funções para a personalização da SDK. A função setThemeConfiguration() serve para personalizar a aparência da SDK, para deixá-la em concordância com a estética do seu aplicativo. As funções setShowInstructionScreen() e setShowSuccessScreen() servem para renderizar, respectivamente as telas de introdução e de sucesso da SDK. Caso for utilizar a SDK em ambiente de homologação, você deve utilizar a função setSandboxEnvironment(). Por fim, você deve chamar a função build() para instânciar a classe WebOCR com as configurações passadas. Para mais informações e detalhes sobre o construtor, veja a página sobre o construtor.

Com a classe WebOCR devidamente instanciada, chame a função initialize() passando como parâmentro o tipo do documento desejado para inicializar a SDK. Ao final do fluxo de captura de documento, serão retornadas as ocr_keys referentes às imagens que foram capturadas. Caso aconteça algum erro, este também pode ser mapeado através da utilização do método catch(). Para mais informações e detalhes sobre a função initialize, veja a página sobre a função.