Browser support
Your application must use React 18.0 or higher and a browser that is ES6-compatible. Check the full compatibility list here. Use a standard bundler such as Vite, Webpack, or Next.js. Microphone access requires HTTPS in production. If your application is embedded in an iframe, addallow="microphone; clipboard-write" on that iframe (add clipboard-read if your flow needs it).
Authentication requirements
Your authentication system must meet the following requirements:- It must be OAuth-compliant.
-
It must provide a JWT token signed with RS256 that contains a consistent, unique user identifier, plus the
exp,iss, andaudclaims. - It must have a publicly accessible JWKS endpoint for token signature validation.
Information you must provide
As a Suki development partner, you must provide the following items to your Suki contact before you can integrate the Suki Headless 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 use the Suki Headless Web SDK. We need these URLs to add your application to our allowlist.
Information you will receive from Suki
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
partnerIdwhen you initialize the Suki Headless Web SDK.