Get Started

1. To begin, obtain your necessary API credentials from Qure.

2. Ensure that your system has all necessary dependencies installed. This typically includes libraries and tools for handling HTTP requests and processing DICOM files, depending on the programming language and framework you are using.

3. Your system should be capable of handling DICOM files, as this is the primary data format used in the Platform APIs.

4. Implement standard security protocols to safeguard data transmission. This includes using HTTPS for API requests and adhering to any data privacy regulations relevant to your region.

It is recommended that you anonymise the DICOM files before they are uploaded with the API.

Perform Health Check

Before you begin, you need to do a health check using /health_check API. This helps you to make sure that all systems are online and connected.

API Format

GET /health_check

Request Formats

cURL

curl -X GET \\
-L 'Base_URL/health_check' \\
-H 'Authorization: Token <PASTE_YOUR_TOKEN>' 

Python

import requests

url = "Base_URL/health_check"

# Headers, including the Authorization token and Source
headers = {
    'Authorization': 'Token <PASTE_YOUR_TOKEN>'
}

# Perform the GET request
response = requests.get(url, headers=headers)

# Print the response text
print(response.text)

Success Response

If all systems are online, you will receive a 200 OK response

Other Responses

In case of any issues, you will receive a 502 Bad Gateway response.