Skip to main content

​
Overview

We have modularized the Suki Web SDK into framework-specific packages so you only need to install the one that fits your environment. The SDK is built for modern JavaScript and requires an ES6 compatible browser.

​
Prerequisites

For the rest of this documentation, we will assume you have completed the partner onboarding process and that:
  • You have received your partnerId from Suki
  • Your partner configuration includes a valid JWKS endpoint
  • Your authentication token contains the correct user identifier (e.g., sub, email)

​
Install The Package

​
For Plain JavaScript

You can use the @suki-sdk/js package for plain JavaScript projects or with frameworks like Vue, Angular, or Solid.js. This package provides the core SDK functionality without tying it to a specific UI library. To install the package, run one of the following commands: 
pnpm add @suki-sdk/js

​
For React

For React applications, you should use the @suki-sdk/react package. It includes React-specific hooks and components that make it easy to integrate Suki’s functionality into your application. To install the package, run one of the following commands: 
pnpm add @suki-sdk/react

​
Next Steps

Read the Quickstart Guide guide to get started with the Suki SDK.