V3 API User Sessions

User Sessions

---

Create a User Session

POST v3/auth/user-sessions

Request

Headers

X-Developer-Id	developer id
X-Api-Key	api key

 

Parameters (Payload)

hospitalId	int
userTypeId	int	patient 1, provider (staff) 2, snapmd admin 3
email	string	username
password	string
interfaceTypeId	int	none 0, patient 1, provider 2, admin 3, snapmdadmin 4
deviceId	string	device associated with the session, for renewal

Response

apiSessionId	session id
accessToken	session token
expires	expiration date time

Sample Request / Response

---

Create a SSO User Session

POST v3/auth/user-sessions/sso

Request

Headers

X-Developer-Id	developer id
X-Api-Key	api key

 

Parameters (Payload)

hospitalId	int
jwt	string	JWT Token
userSessionOptions	UserSessionOptions	(optional) {"encryptedFields":"secure option", "language":"es"}

Response

apiSessionId	session id
accessToken	session token
expires	expiration date time

Sample Request / Response

---

Delete Current User Session

DELETE v3/auth/user-sessions

Request

Headers

X-Developer-Id	developer id
X-Api-Key	api key
Authorization	Bearer {{access_token}}

 

---

Renew a User Session Based on Earlier Unclosed Session

NOTE: Will be closed after renewed.

POST v3/auth/user-sessions/renewal

Request

Headers

X-Developer-Id	developer id
X-Api-Key	api key

 

Parameters (Payload)

hospitalId	int
userTypeId	int	patient 1, provider (staff) 2, snapmd admin 3
email	string	username
accessToken	string	earlier unclosed session
deviceId	string	device associated with the session, for renewal

Response

apiSessionId	session id
accessToken	session token
expires	expiration date time