Outlines
The Diagnosis API is available at
https://diagnosisapi.azurewebsites.net. All requests to the API must be made via HTTPS. The API hosted on Azure storage. Azure Storage currently supports three versions of the TLS protocol: 1.0, 1.1, and 1.2. Azure Storage uses TLS 1.2 on public HTTPS endpoints, but TLS 1.0 and TLS 1.1 are still supported for backward compatibility.
Also, that provides cross-origin resource sharing (CORS) to allow client-side code of web applications to interact with the Diagnosis API, but please make sure you never expose your API credentials in any client-side code of public websites.
HTTP Methods
The Diagnosis API can be easily integrated with any existing HTTP client by using any popular programming languages and frameworks. The API content is read-only and all of the API responses always return the same output for the same input, no matter how many times you call them. As any RESTfull service, the API supports four HTTP methods: DELETE, PUT, GET, and POST. However, you need to use only two last of them.
Use GET requests to retrieve data that do not require any data to be sent in the request's body.
Use POST requests for actions that require data to be sent in the request's body (e.g. /api/DDxItems).
JSON
JSON is the only data format supported by Diagnosis API. All of our endpoints return JSON objects or lists. Moreover, the POST actions expect request bodies formatted as JSON objects. Error messages are also in JSON. Requests, like responses, should be encoded in UTF-8.
Authentication
Diagnosis API uses a custom authentication mechanism. Each request must include non-standard HTTP header: AuthenticationID. This parameter corresponds to your unique application ID. For your Demo Development you can use AuthenticationID = DEMO_AuthenticationID. We will provide you with your unique AuthenticationID after registration.
An example of a request could look like this (finally you will replace DEMO_AuthenticationID with your credentials):
'https://diagnosisapi.azurewebsites.net/api/DDxItems/?AuthenticationID=DEMO_AuthenticationID'