Pular para o conteúdo principal

Inicialização

Quando inicializar

Inicialize o SDK o mais cedo possível — normalmente quando a página ou componente que contém o frame de captura é carregado. Consulte Boas práticas para detalhes sobre por que você não deve inicializar ao clicar no botão de captura.

Incorporando credenciais

Implemente a classe UnicoConfig com as credenciais fornecidas pelo time de Onboarding:

import { UnicoConfig } from "unico-webframe"

const config = new UnicoConfig()
  .setHostname("<YOUR_HOSTNAME>")
  .setHostKey("<YOUR_HOST_KEY>");
Instanciar o builder

Crie uma nova instância de UnicoCheckBuilder:

const unicoCameraBuilder = new UnicoCheckBuilder();
Configurar caminhos de recursos

Especifique o caminho dos arquivos adicionais (se adicionados ao seu projeto):

unicoCameraBuilder.setResourceDirectory("/resources");

Especifique o caminho dos arquivos de modelo de IA (necessário apenas para o modo Smart camera):

unicoCameraBuilder.setModelsPath("https://meusite.com.br/models");
Busca automática desde a versão 3.18.0

A partir da versão 3.18.0, o SDK pode buscar automaticamente os recursos adicionais — basta não implementar setResourceDirectory e garantir que a configuração de CSP esteja aplicada corretamente.

Configurar CSS Reset (opcional)

Por padrão, o SDK aplica um CSS Reset para garantir consistência visual entre os componentes. Para preservar os estilos CSS da sua aplicação, desative este recurso:

unicoCameraBuilder.disableCssReset();
Seleção de ambiente

A escolha entre sandbox e produção é feita durante a inicialização. Use o enum SDKEnvironmentTypes:

  • SDKEnvironmentTypes.PROD — ambiente de produção
  • SDKEnvironmentTypes.UAT — ambiente de homologação
import {
  UnicoCheckBuilder,
  SDKEnvironmentTypes
} from "unico-webframe"

unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);
informação

Se não configurado, o Web SDK utiliza o ambiente de produção por padrão.

Para a lista completa de tipos de ambiente disponíveis, consulte Referência de API > API de Inicialização.

Ciclo de vida

A autenticação do SDK com o backend leva alguns segundos. Inicialize cedo, não quando o usuário clicar no botão de captura — caso contrário, o usuário experimenta lentidão entre o clique e a abertura da câmera.

Última atualização em