Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document describes the various representational state transfer application programming interface (REST API) implementations that can be used to access TCIA data and resources. The APIs form a RESTful interface, accessed through web URLs. An application developer does not need to download any software to use the APIs. The application developer can build their own access routines using only the API documentation provided. 

Two TCIA currently offers two RESTful interfaces currently existto its DICOM imaging data, as follows:

  • The TCIA REST APIs, originally : Originally developed using Project Bindaas with Emory University, these APIs provide programmatic access only to public collections and do not require authentication but only allows access to public collectionsto use them. The TCIA REST API Guide describes these APIs.  Anyone may use these APIs without asking for an API key or secret, since they only access public collections.
  • The National Biomedical Imaging Archive (NBIA) Search REST APIs: Provided as part of the NBIA software, these APIs power the search and download functions used in the TCIA radiology portal, and allow access to both public and private limited access collections. The NBIA Search REST API Guide describes these APIs. In order to use these APIs, a developer must request a Client ID and Client Secret from the TCIA Help Desk, then use that Client ID and Client Secret to obtain an OAuth2 token. That token must be passed to the server in the https headers of API calls. This process is outlined in the guide.

...