Instalación

Instalación del componente Facephi SDK Web.

El SDK Web es una librería de componentes custom elements compatibles con cualquier framework actual.

Existen dos versiones de la librería SDK Web:

  • SDK Web WebComponents: Librería web-components, compatible con la mayoría de frameworks y entornos.

  • SDK Web React: Versión de componentes nativos react. Esta librería cuenta con todas las funcionalidades que la versión WebComponents, pero con la sintaxis aplicable a react.


🔑 Credenciales de descarga

Crea un archivo llamado .npmrc en la raíz de tu proyecto con el siguiente contenido:

@facephi:registry=https://facephicorp.jfrog.io/artifactory/api/npm/sdk-web-fphi/
//facephicorp.jfrog.io/artifactory/api/npm/sdk-web-fphi/:_password=[TU_TOKEN]
//facephicorp.jfrog.io/artifactory/api/npm/sdk-web-fphi/:username=[TU_USUARIO]
//facephicorp.jfrog.io/artifactory/api/npm/sdk-web-fphi/:email=[TU_EMAIL]
//facephicorp.jfrog.io/artifactory/api/npm/sdk-web-fphi/:always-auth=true

Reemplaza [TU_TOKEN], [TU_USUARIO] y [TU_EMAIL] con las credenciales proporcionadas.


📦 Instalación de la librería

Existen dos formas principales de integrar el SDK Web de Facephi en tu aplicación. Mediante un gestor de paquetes o por CDN. En ambos casos se ofrecen las mismas funcionalidades.

📦 Instalación mediante gestor de paquetes

Recomendada para proyectos que utilizan frameworks modernos como React, Angular o Vue.

El paquete del SDK Web está alojado en un repositorio privado de NPM. Sigue estos pasos para instalarlo:

SDK Web Components

Ejecuta el siguiente comando en la terminal de tu proyecto:

SDK React

Si te encuentras en un entorno React, puedes instalar la versión SDK React para utilizar componentes nativos react en lugar de web components:

Asegúrate de que la instalación se complete sin errores antes de continuar.


☁️ Instalación desde CDN

Para proyectos que no utilizan un gestor de paquetes, puedes integrar el SDK usando un enlace CDN:

Esto cargará la versión más reciente del SDK directamente desde los servidores de Facephi.

El resto de la integración es el mismo para ambos casos.


✅ Próximos pasos

Last updated