QTS API Reference
Environment: Test/UAT

Overview

The QTS API is a collection of RESTful APIs that provide a way for systems to query and update data within QTS.

Environments

In addition to the production environment, QTS provides a sandbox environment for testing API implementations. When requesting access to use the API specify the environment.

Authentication

A subscription key is required to use the QTS API. The subscription key must be sent with each request either in the request header or the request query string. A subscription key is required for each environment. To request a subscription key contact the QTS support team.

If you already have a subscription key click the "Sign In" link at the top right of this page.

Versioning

Some of the APIs might have multiple versions. Versions provide different or updated functionality. Some versions may be deprecated. Deprecated versions should not be used for a new implementation as they are at end of life and could be decommissioned. Check the API documentation for each version’s status.

If an API is labeled as "Legacy" it should not be used for new implementations unless directed by the QTS support team.

Usage

Get started by requesting a subscription key from the QTS support team. Be sure to specify the environment that will be used.

When making requests to the API

  • Requests must be secure using https. Http is not supported.

  • Supported media-type is “application/json” for requests and responses.

  • Send the subscription key with each request in one of two ways

    • In the header as “Qts-Apim-Subscription-Key”.

    • In the query string as “qts-subscription-key”.

  • For APIs with multiple versions request a specific version in the query string with the “version” parameter. The value of the parameter uses the format “v<version number>”. e.g. To request version 2.1 of an API send the query string parameter with a value of “v2.1”. When requesting major version the “.0” can be omitted. e.g. Version 3.0 can be requested with a value of “v3”.

  • If there is only one version of an API then “v1” must be sent in the "version" parameter in the query string. This is to ensure if/when future versions are released the use of the original version is not disrupted