README

There are two prerequisites for consuming this API:

• Registration
  For security reasons, any and all requests must be verified by providing a 16-character key in the body parameters. This can be created by registering and providing an email address.
• A HTTP client
  Any DICOMs and text files sent to the API are handled over the internet using HTTP. This can be achieved by building a simple HTTP client using one of many programming languages or interfaces. This guide provides examples of how this can be done using several popular ones. The examples shown provide the basic syntax for constructing a HTTP client, executing a request to the API and reading the response, using an appropriate library for each language. This is fundamentally the same as using X-Raydar Online, only by using your own software to interact with the API. This grants the freedom to handle the report returned from the algorithm however is necessary.

URL and Key Placeholders

In each example shown on how to build a HTTP client in various languages, there are three placeholders that must be filled for the request to be valid, unless otherwise stated.

URL

					
<URL goes here>
					
				

URL option available:

• https://x-raydar.info/api/cv

  for DICOM files and the Computer Vision algorithm

Key

					
<Key goes here>
					
				

As mentioned, registration is necessary to consume the API. Insert the 16 character string received in the registration email here.

File Path

Replace this section with the complete or relative path to the file you wish to send:

					
/path/to/file