Documentation Hub
Web SDK
Why Keyless?Start HereMobile SDKWeb SDKWorkforceIDV BridgeUser GuideAdmin portalOn-Premise
Web SDK
Why Keyless?Start HereMobile SDKWeb SDKWorkforceIDV BridgeUser GuideAdmin portalOn-Premise
  • Keyless Web SDK Documentation
  • Introduction
    • Components
    • Integration Flows
  • Web SDK Guide
    • Getting Started
    • Enrollment
    • Authentication
    • Browser Requirements
  • Web SDK Reference
    • UI Customization
    • Localization
    • Lockout Policy
    • Error Handling
    • Camera Permission Flow
    • Signing Transactions
Powered by GitBook
On this page
  • Prerequisites
  • Installation

Was this helpful?

  1. Web SDK Guide

Getting Started

Last updated 18 days ago

Was this helpful?

In this short guide, you will learn how to integrate the Keyless Web SDK in your web application, and enroll and authenticate users through the Keyless platform.

Before jumping into your code editor, make sure that you're familiar with the various of the authentication system, and common biometric .

Prerequisites

Make sure you have all the required keys.

  • CLOUDSMITH_TOKEN to download the Web SDK from cloudsmith repository

  • CUSTOMER_NAME to define the customer

  • KEYLESS_AUTHENTICATION_SERVICE_URL to estabilish a connection

  • IMAGE_ENCRYPTION_PUBLIC_KEY for the image encryption to work

  • IMAGE_ENCRYPTION_KEY_ID for the image encryption to work

Installation

First of all you must authenticate with our cloudsmith repository, in the root of your project folder create a file called .npmrc and write this line inside:

@keyless:registry=https://npm.cloudsmith.io/keyless/partners/

Then with the token that was given to you by Keyless, launch this command on your terminal:

npm config set //npm.cloudsmith.io/keyless/partners/:_authToken=CLOUDSMITH_TOKEN

Now you’re all set to install our packages. Meaning that you can now successfully install @keyless/sdk-web by launching the following command on your terminal:

npm install @keyless/sdk-web@1.2.1

Of course you’re free to use a package manager of your choice, but here in Keyless we use pnpm. Installing the @keyless/sdk-web-components package is the same and can be done with:

npm install @keyless/sdk-web@1.2.1 @keyless/sdk-web-components@1.2.1
components
authentication flows