Introduction to VSee Clinic API

VSee Clinic API allow developer to make their own interface while still having full VSee Clinic and VSee Call capability.

Example Set up

Let's take a look at a typical example set up

Key	Example	Note

Key	Example	Note
Clinic Portal URL	`https://vclinic.com`	This is your original portal
Account code	`vclinic`	Your VSee Clinic Account Code
API Key	`vclinic_api_key`	The key generated under Developers menu
API Secret	`vclinic_api_secret`	The secret generated under Developers menu
Admin Token	`vclinic_api_token`	The admin token is a special token that allows you to perform admin functions through API. You need to create such tokens manually in your API app. https://developers.vsee.com/wiki/spaces/VD/pages/381517825/Sign+Up+for+a+Developer+Account#Create-an-Admin-token
API Endpoint	`https://api-vclinic.vseepreview.com/vc/stable/api_v3/`	To be advised by VSee Clinic Team
Clinic Portal URL	`https://vclinic.vseepreview.com/vc/stable/`	To be advised by VSee Clinic Team
Waiting Room URL	`https://vclinic.vseepreview.com/vc/stable/u/clinic`	To be advised by VSee Clinic Team
User Code	`mypatient_uuid1234-5678-90`	This is anything that you can formular and act as a way for VSee Clinic to identify the your user

Note: Your clinic setting on Production environment is not available on Staging environment unless set up by VSee Clinic Support team.

Parameter	Location	Type	Description

Parameter	Location	Type	Description
`X-AccountCode`	`Header`	`Header`	If the app knows the account code, it should pass it in this header for every request. Otherwise leave blank
`X-ApiToken`	`Header`	`Header`	Once the user logs in, the app gets the token and should pass it for every request.
`user_id`	`URL`	`String`	Wherever there’s user’s :id field in API methods, it will also accept dash (-) as a mapping to the current user.

VSee Clinic API use standard HTTP response status codes

	Code	Meaning	Response example

	Code	Meaning	Response example
1	`200`	`Success`	`{ data: { // actual payload } }`
2	`400`	`Bad Request`	`{ code: 404, message: "Sorry, this page is not available." }`
3	`401`	`Unauthorized`
4	`403`	`Forbidden`
5	`404`	`Not Found`
6	`429`	`Too Many Requests`
7	`500`	`Internal Server Error`
8	`502`	`Bad Gateway`
9	`503`	`Service Unavailable`
10	`504`	`Gateway Timeout`

(To be completed soon)

Status Code	Meaning	Description

Status Code	Meaning	Description
`10`	Pending	Visit was just created
`20`	Confirmed	Appointment is confirmed
`25`	In-progress	Visit is in progress
`30`	Completed	Visit is closed
`40`	Deleted / Cancelled	Visit is cancelled by patient or provider

Subtype	Meaning	Description

Subtype	Meaning	Description
`1`	In-person	In-person visit, no video call requested
`2`	Phone	Appointment is by phone, no video call requested
`3`	Video	Default: VSee video call
`4`	E-consult	Async visit, no video call