Initialisation

Où initialiser

Initialisez le SDK le plus tôt possible — généralement lorsque la page ou le composant contenant le cadre de capture se charge. Consultez les Bonnes pratiques pour savoir pourquoi vous ne devez pas initialiser lors du clic sur le bouton de capture.

Intégration des identifiants

Implémentez la classe UnicoConfig avec les identifiants fournis par l'équipe d'intégration :

import { UnicoConfig } from "unico-webframe"

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

Instancier le builder

Créez une nouvelle instance de UnicoCheckBuilder :

const unicoCameraBuilder = new UnicoCheckBuilder();

Configurer les chemins des ressources

Spécifiez le chemin des fichiers supplémentaires (s'ils sont ajoutés à votre projet) :

unicoCameraBuilder.setResourceDirectory("/resources");

Spécifiez le chemin des fichiers de modèles IA (requis uniquement pour le mode caméra Smart) :

unicoCameraBuilder.setModelsPath("https://meusite.com.br/models");

Récupération automatique depuis la version 3.18.0

À partir de la version 3.18.0, le SDK peut récupérer automatiquement les ressources supplémentaires — il suffit de ne pas implémenter setResourceDirectory et de s'assurer que la configuration CSP est appliquée correctement.

Configurer le CSS Reset (facultatif)

Par défaut, le SDK applique un CSS Reset pour garantir la cohérence visuelle entre les composants. Pour préserver les styles CSS de votre application, désactivez cette fonctionnalité :

unicoCameraBuilder.disableCssReset();

Sélection de l'environnement

Le choix entre sandbox et production s'effectue lors de l'initialisation. Utilisez l'énumération SDKEnvironmentTypes :

SDKEnvironmentTypes.PROD — environnement de production
SDKEnvironmentTypes.UAT — environnement de staging

import {
  UnicoCheckBuilder,
  SDKEnvironmentTypes
} from "unico-webframe"

unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);

info

Si elle n'est pas configurée, le Web SDK utilise l'environnement de production par défaut.

Pour la liste complète des types d'environnement disponibles, consultez Référence API > API d'initialisation.

Cycle de vie

L'authentification du SDK avec le backend prend quelques secondes. Initialisez tôt, pas au moment où l'utilisateur clique sur le bouton de capture — sinon l'utilisateur ressent un décalage entre le clic et l'ouverture de la caméra.