Installation

Installation of the Facephi Web SDK component.

The SDK Web is a component library custom elements compatible with any current framework.

There are two versions of the SDK Web library:

• SDK Web WebComponents: web-components library, compatible with most frameworks and environments.

• SDK Web React: Native React component version. This library has all the functionality of the WebComponents version, but with syntax applicable to React.

---

Download credentials

Create a file called .npmrc in the root of your project with the following content:

@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

Replace [TU_TOKEN], [TU_USUARIO] and [TU_EMAIL] with the provided credentials.

---

Library installation

There are two main ways to integrate Facephi's SDK Web into your application. Using a package manager or via CDN. In both cases, the same features are offered.

Installation via package manager

Recommended for projects that use modern frameworks such as React, Angular, or Vue.

The SDK Web package is hosted in a private NPM repository. Follow these steps to install it:

SDK Web Components

Run the following command in your project's terminal:

npm install @facephi/sdk-web-wc

There are also versions for React and Angular with a native version for those environments. See the section on Integration in frameworks for more information.

Make sure the installation completes without errors before continuing.

---

Installation from CDN

For projects that do not use a package manager, you can integrate the SDK using a CDN link:

import 'https://cdn.facephi.pro/@facephi/sdk-web-wc@latest/bundle?bundle=false';
import { defineCustomElements as defineCustomFacephiSDKElements } from 'https://cdn.facephi.pro/@facephi/sdk-web-wc@latest/bundle?bundle=false';

defineCustomFacephiSDKElements(window);

This will load the latest Version of the SDK directly from Facephi's servers.

The rest of the integration is the same for both cases.

---

Next steps

• Continue with the Initial configuration.

• Check the Integration examples.