Platform support
Your application must target iOS 13.0 or later in Xcode. You must addSukiAmbientCore.framework to your project and set it to Embed & Sign. You must also add the NSMicrophoneUsageDescription key to your Info.plist with a clear explanation of why your app needs microphone access.
For installation steps, refer to the Installation guide.
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.
-
You must implement the
tokenProviderprotocol so the Mobile SDK can request authentication tokens when needed. -
You must set the SDK environment to
.stagefor development and.prodfor production.
tokenProvider and environment setup, refer to the Configuration guide.
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 Mobile 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.
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 Mobile SDK.