Primeros pasos
Una vez instalado el SDK Web, es necesario realizar una configuración inicial para que funcione correctamente en tu aplicación.
✏️ Definir el Componente
La biblioteca proporciona un loader para definir el componente personalizado. Este debe ser llamado para que el navegador lo interprete correctamente.
import { defineCustomElements as defineFacephiSdkCustomComponent } from '@facephi/sdk-web-wc/loader';
// Asocia los elementos personalizados al objeto window
defineFacephiSdkCustomComponent(window);Se recomienda añadir un alias para la definición del componente personalizado del SDK.
🔑 Obtener una Licencia
Para utilizar el SDK Web, solicita una licencia al equipo de soporte de Facephi. Una vez obtenida, utiliza la ApiKey proporcionada para configurar el SDK:
<facephi-sdk-provider apikey="TU_APIKEY">
<!-- Aquí se colocarán los widgets -->
</facephi-sdk-provider>Cada licencia (ApiKey) tiene asociada las credenciales necesarias para el uso de los diferentes componentes y funcionalidades de manera interna, vinculados al dominio en el que se usará.
🧩 ¿Cómo se usa?
El SDK Web sigue el estándar de Web Components, utilizando un componente proveedor llamado <facephi-sdk-provider>. Este proveedor envuelve toda la lógica del SDK y proporciona la funcionalidad esencial necesaria para que los widgets funcionen correctamente.
Es obligatorio incluir el <facephi-sdk-provider> en tu aplicación. Sin él, los widgets no funcionarán correctamente. Este proveedor actúa como la capa base para integrar el SDK en tu aplicación.
Ejemplo de Integración
Para comenzar, envuelve el <facephi-sdk-provider> alrededor de tu aplicación o de los widgets que deseas usar. A continuación, un ejemplo de integración del widget Selphid dentro del proveedor:
Esta estructura asegura que el widget SelphID funcione correctamente con toda la funcionalidad requerida proporcionada por el proveedor del SDK.
Toda la información de configuración del Componente SDK Provider la podrás encontrar en esta sección.
Para ejemplos más completos de integración, consulta la página de ejemplos de programación.
🎯 Recomendaciones
✅ Próximos pasos
Configura los Componentes y módulos según tus necesidades.
Explora los Ejemplos de integración.
Revisa los apartados específicos de cada módulo como Selphi, SelphID o Video Recording.
Last updated