Saltar al contenido principal

Inicialización

Dónde inicializar

Inicialice el SDK lo antes posible — normalmente cuando se carga la página o el componente que contiene el marco de captura. Consulte Buenas prácticas para obtener detalles sobre por qué no debe inicializarse al hacer clic en el botón de captura.

Incorporar credenciales

Implemente la clase UnicoConfig con las credenciales proporcionadas por el equipo de Onboarding:

import { UnicoConfig } from "unico-webframe"

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

Cree una nueva instancia de UnicoCheckBuilder:

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

Especifique la ruta de los archivos adicionales (si se agregaron a su proyecto):

unicoCameraBuilder.setResourceDirectory("/resources");

Especifique la ruta de los archivos del modelo de IA (solo requerida para el modo Smart camera):

unicoCameraBuilder.setModelsPath("https://meusite.com.br/models");
Obtención automática desde 3.18.0

A partir de la versión 3.18.0, el SDK puede obtener automáticamente los recursos adicionales — simplemente no implemente setResourceDirectory y asegúrese de que la configuración CSP esté aplicada correctamente.

Configurar CSS Reset (opcional)

De forma predeterminada, el SDK aplica un CSS Reset para garantizar la consistencia visual entre los componentes. Para conservar los estilos CSS de su aplicación, deshabilite esta función:

unicoCameraBuilder.disableCssReset();
Selección de entorno

La elección entre sandbox y producción se realiza durante la inicialización. Utilice el enum SDKEnvironmentTypes:

  • SDKEnvironmentTypes.PROD — entorno de producción
  • SDKEnvironmentTypes.UAT — entorno de staging
import {
  UnicoCheckBuilder,
  SDKEnvironmentTypes
} from "unico-webframe"

unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);
información

Si no se configura, el Web SDK utiliza el entorno de producción de forma predeterminada.

Para obtener la lista completa de tipos de entorno disponibles, consulte Referencia de API > API de inicialización.

Ciclo de vida

La autenticación del SDK con el backend tarda unos segundos. Inicialice con anticipación, no cuando el usuario hace clic en el botón de captura — de lo contrario, el usuario experimentará un retraso entre el clic y la apertura de la cámara.

Última actualización el