Testing Connection

Description

Testing the connection to a new system is often one of the first tasks developers undertake. To check if you can successfully connect to the system, there's an endpoint available. This endpoint doesn't perform any specific actions but will return a success response if your API key is valid and the connection is successful. If the call is successful, it will result in an HTTP 200 (OK) response.

However, if you fail to provide an API key or provide an unrecognized API key, the system will respond with an HTTP 401 (Unauthorized) status code, indicating that you don't have permission to access the system. This is a crucial step to verify that your API key is valid and that your system can communicate with the conneQt platform.

HTTP Definition

Method: POST Endpoint URL: /api/v1/test

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.

URL Parameters

The request contains no URL parameters.

Request JSON Definition

This message does not include a request payload.

POST https://int.conneqt.health/api/v1/test HTTP/1.1
ApiKey: <API-KEY-PLACEHOLDER>

Response JSON Definition

This message does not include a response payload.

HTTP/1.1 200 OK

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
401 Unauthorized Missing or Invalid API Key in the Request Header.
500 Internal Server Error Internal Server Error - An Internal Server Error Prevented the Request from Being Processed.

See also