Use Case #1: Provider Accessing Web Dashboard using SSO Token
Usecase: I already have a way to sign up, manage my provider on my own providers' portal and now I want them to go to VSee Clinic for additional telehealth functionality.
Here is how you log in and redirect your provider using access token.
Step 1: Obtain provider access token from POST /users/sso API call
The API will return you the token (data.token.token
) look like this 66bcd0acff324e8a44992d9596b5d361
.
Step 2: Redirect the provider to their dashboard
You need to provide the user with a button or link to redirect to VSee Clinic. URL will follow this pattern
{portal_base_url}auth?sso_token={token}&next={next_url}
e.g https://vclinic.vseepreview.com/vc/next/auth?sso_token=66bcd0acff324e8a44992d9596b5d361&next=/providers/dashboard
This will log user in, then redirect user to https://vclinic.vseepreview.com/vc/next/providers/dashboard
Use Case #2: Create a Provider Account With a Room
Usecase: I already have a way to sign up, manage my provider on my own providers' portal and now I want them to go to VSee Clinic for additional telehealth functionality. My portal has multiple providers, each provider should have their own Waiting Room in VSee Clinic to accept their own pool of patients.
Step 1: Obtain provider access token from POST /users/sso API call
The API will return you the token (data.token.token) look like this 66bcd0acff324e8a44992d9596b5d361
.
Step 2: Create a waiting room in the clinic via POST /rooms API call
The API will return you the room ID and room code (data.id
, data.code
). If the room already exists, it will return error 400.
Step 3: Assign the newly created provider to the waiting room via POST /users/:id/rooms API call
Step 4: Redirect the provider to their dashboard. The provider will be assigned to a room already and be able to see patients from that room.
You need to provide the user with a button or link to redirect to VSee Clinic. URL will follow this pattern
{portal_base_url}auth?sso_token={token}&next={next_url}
e.g https://vclinic.vseepreview.com/vc/next/auth?sso_token=66bcd0acff324e8a44992d9596b5d361&next=/providers/dashboard
This will log user in, then redirect user to https://vclinic.vseepreview.com/vc/next/providers/dashboard