Pular para o conteúdo principal

Leitura de documento

O SDK de leitura de documento permite acessar processos de leitura de documentos e medir as interações do usuário com o documento para informar os tempos de leitura de cada página individualmente.

Este SDK possui medidas de segurança que proíbem o acesso ao documento se ele for privado, por meio da validação de código OTP usando o método de distribuição selecionado na criação do processo, seja WhatsApp ou e-mail.

aviso

Se o processo for público, qualquer pessoa pode acessar o documento com o link. A única etapa necessária que o usuário deve concluir antes de acessar o processo de leitura é informar seu endereço de e-mail, que o identificará nas métricas de leitura.

Exemplo de integração​

aviso

Para a integração, é necessário ter um elemento <iframe id='iframeId'> onde o SDK será renderizado, e a função AucoSDK deve receber o ID desse elemento.

info

Acesse o link para ver a referência dos eventos necessários para a integração de um SDK: 👉🏻 Eventos

import { AucoSDK } from 'auco-sdk-integration';

const unsubscribe = AucoSDK({
iframeId: 'iframeId',
sdkType: 'sign',
language: 'es', // Accepted language 'es' | 'en'
events: {
onSDKReady,
onSDKClose,
onSDKToken,
},
sdkData: {
document: 'WO0J4L3YWB', // Reading process code
signFlow: 'read',
email: 'reader@auco.ai', // Optional: Reader email if it is necessary to skip the OTP validation step
uxOptions: {
primaryColor: '#021c30',
alternateColor: '#a557f2',
},
},
env: process.env.PUBLIC_ENVIRONMENT === 'dev' ? 'DEV' : 'PROD',
});
aviso

Se o e-mail do leitor for configurado em um processo privado, ele será validado em relação à lista de pessoas com acesso. Se um e-mail for configurado para alguém que não tem acesso ao documento, o SDK exibirá uma mensagem de erro e a pessoa não poderá acessá-lo.

O campo de e-mail do leitor foi projetado pensando no gerenciamento de sessão em app.auco.ai. Portanto, se o e-mail for incluído, também é necessário configurar o evento onSDKToken, que deve retornar um token de usuário válido.