Get Instant Messaging Access Token

Description

Endpoint used to obtain an instant messaging access token for a specific practitioner user.

HTTP Definition

Method: POST
Endpoint URL: /api/v1/messages/instant/access/token

Headers

The following HTTP headers are required with this request:

Name Data Type Notes
ApiKey string The unique key issued by Quicksilva to identify your system.
Content-Type string Must define the request content as 'application/json'.

URL Parameters

The request contains no URL parameters.

Request JSON Definition

Name Cardinality Data Type Notes
accessCode 1..1 string Unique code obtained from the toolbar to register for instant message access. 
POST https://int.conneqt.health/api/v1/messages/instant/access/token HTTP/1.1
Content-Type: application/json; charset=utf-8
ApiKey: <API-KEY-PLACEHOLDER>

{
  "accessCode": "JH23MA1Z"
}

Response JSON Definition

Name Cardinality Data Type Notes
token 1..1 string a UUID access token 
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "token": "ea4f820e-f352-4515-af73-630220045ef0"
}

Error Responses

If there was an issue processing your request, a HTTP error response will be returned, containing details of the issue. Common problems include:

  • One or more invalid data items were found in the request.
  • The intended recipient organisation is not one that uses our system.

The system uses the definition of an IETF Problem, as described in RFC 7807, in error responses to provide machine-readable details of why a request was rejected. The content of the Problem returned depends on the nature of the issue.

HTTP Response Code HTTP Reason Code Description
400 Bad Request Validation issues found in your request.
401 Unauthorized Missing or Invalid API Key in the Request Header.
403 Forbidden Unauthorized Client System - The Provided API Key Is Valid but Not Authorized.
500 Internal Server Error Internal Server Error - An Internal Server Error Prevented the Request from Being Processed. 
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json

{
  "type": "https//qxlva.com/im1toolbar/documentation/api/v1/validation-error",
  "title": "Request Validation Error",
  "status": 400,
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
  "invalidParameters": [
    {
      "name": "accessCode",
      "reason": "Unknown Access Code"
    }
  ]
}

See Also