[New] VSee Clinic API
- 1 Introduction to VSee Clinic API
- 1.1 Example Set up
- 2 API Documentation
- 2.1 API Setup
- 2.1.1 API Endpoints
- 2.1.2 API Parameters
- 2.1.3 API Errors
- 2.2 API Objects
- 2.2.1 User Object
- 2.2.2 Visit Object
- 2.2.3 Intake Object
- 2.3 Settings API
- 2.4 Users API
- 2.5 EMR API
- 2.6 Pharmacy API
- 2.7 Visits API
- 2.8 Payment API
- 2.9 Clinic Account API
- 2.10 Rooms API
- 2.11 Push Notification API
- 2.12 File Upload API
- 2.13 VSee Clinic Webhooks
- 2.14 Recordings API
- 2.1 API Setup
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 |
---|---|---|
Clinic Portal URL |
| This is your original portal |
Account code |
| Your VSee Clinic Account Code |
API Key |
| The key generated under Developers menu |
API Secret |
| The secret generated under Developers menu |
API Endpoint |
| To be advised by VSee Clinic Team |
Clinic Portal URL |
| To be advised by VSee Clinic Team |
Waiting Room URL |
| To be advised by VSee Clinic Team |
User Code |
| This is anything that you can formular and act as a way for VSee Clinic to identify the your user |
API Documentation
API Setup
API Endpoints
Production:Â
https://api.vsee.me/api_v3/
Staging:Â
https://api.vseepreview.com/vc/next/api_v3/
Note:Â Your clinic setting on Production environment is not available on Staging environment unless set up by VSee Clinic Support team.
API Parameters
Parameter | Location | Type | Description |
---|---|---|---|
|
|
| If the app knows the account code, it should pass it in this header for every request. Otherwise leave blank |
|
|
| Once the user logs in, the app gets the token and should pass it for every request. |
|
|
| Wherever there’s user’s :id field in API methods, it will also accept dash (-) as a mapping to the current user. |
API Errors
VSee Clinic API use standard HTTP response status codes
Code | Meaning | Response example | |
---|---|---|---|
1 |
|
| {
data: {
// actual payload
}
} |
2 |
|
| {
code: 404,
message: "Sorry, this page is not available."
} |
3 |
|
| |
4 |
|
| |
5 |
|
| |
6 |
|
| |
7 |
|
| Â |
8 |
|
| Â |
9 |
|
| Â |
10 |
|
| Â |
API Objects
User Object
(To be completed soon)
Visit Object
status
:
Status Code | Meaning | Description |
---|---|---|
| Pending | Visit was just created |
| Confirmed | Appointment is confirmed |
| In-progress | Visit is in progress |
| Completed | Visit is closed |
| Deleted / Cancelled | Visit is cancelled by patient or provider |
subtype:
Subtype | Meaning | Description |
---|---|---|
| In-person | In-person visit, no video call requested |
| Phone | Appointment is by phone, no video call requested |
| Video | Default: VSee video call |
| E-consult | Async visit, no video call |
subtype
Intake Object
(To be completed soon)
Settings API
See [New] Settings APIarchived
Users API
EMR API
Pharmacy API
See
Visits API
See
Payment API
See
Clinic Account API
See
Rooms API
See
Push Notification API
Mostly for mobile app
See
File Upload API
See
VSee Clinic Webhooks
See
Â
Â
Â
Â