Prerequisites

Overview

This guide outlines the technical requirements your application must meet to integrate with the Suki Platform web SDK.

Your application must use a browser that is ES6-compatible. You can check the full compatibility list here.

Your authentication system must meet the following requirements:

It must be OAuth-compliant.
It must provide a JWT token that contains a consistent, unique user identifier.
It must have a publicly accessible JWKS endpoint for token signature validation.

For more information on the authentication requirements, refer to the Partner Authentication guide.

As a Suki development partner, you must provide the following items to your Suki contact before you can integrate the Suki Web SDK:

Partner name: A unique name that identifies your EMR/EHR.
JWKS endpoint: The publicly accessible URL that Suki will use to validate the signature on user JWT tokens. This is provided by your identity provider.
User identifier field: The specific key name in your JWT token that uniquely identifies a user. This can be email, username, userId, sub, or another field that represents the user uniquely in your system.
Host URLs: The public URLs for your test and production client applications where you will embed the Suki Web SDK. We need these URLs to add your application to our allowlist.

Before you can start the integration, your Suki contact will provide you with the following:

Partner ID: A unique identifier issued by Suki. You must send this partnerId when you initialize the Suki Web SDK.

For more information on the information you will receive from Suki, refer to the Partner Onboarding guide.