Telehealth Public APIs
  1. SSO Login
Telehealth Public APIs
  • Introduction
  • SSO Login
    • Generate SSO token
      POST
    • SSO Login
      GET
  • General APIs
    • Create Patient
      POST
    • Upload Patient File
      POST
    • Submit Patient's Form Response
      POST
    • Lab readings
      POST
    • Assign Service to Patient
      POST
    • Create Patient's Chart Note
      POST
    • Get Provider's Appointment Slots
      POST
    • Provider Sign Up
      POST
    • GraphQL Get Patient(s)
      POST
  1. SSO Login

Generate SSO token

POST
/sso/token
Used to generate user access token. Username and password belongs to the patient/provider created from patient/provider portal.
Path Variables: None
Query Parameters: None
Body Parameters:
FieldTypeDescription
usernamestringRequired. Email of Provider/Patient.
passwordstringRequired. Password of Provider/Patient.
redirectParamstringOptional. Redirct URL for Patient/Provider portal.
Example Request:
{

"username": {{email}},
"password":{{password}},
"redirectParam": {{url}}
}
Example Success Response:
Status: 200
{

"userAccessToken": {{userAccessToken}},
}
Example Failure Response:
Status: 400 or 500
{

"error": true,
"message": "Request Failed. {{error_message}}"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params text/plain
Example
Example:{ "username": "{{email}}", "password":"{{password}}", "redirectParam": "{{url}}" }

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/sso/token' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "{{email}}",
    "password":"{{password}}",
    "redirectParam": "{{url}}"
}'

Responses

🟢200Generate SSO token
application/json
Body

Example
{
    "userAccessToken": {{userAccessToken}}
}
Modified at 2024-10-16 08:52:29
Previous
Introduction
Next
SSO Login
Built with