OpenSpecimen exposes REST APIs that can be consumed to developed custom interfaces and for integration with other databases. The REST APIs will be consumed by the OpenSpecimen user interface.

Common Characteristics of REST Resources

...

• You access a resource by sending an HTTP request to the OpenSpecimen server. The server replies with a response that either contains the data you requested or a status indicator, and in some cases both.

• All resources are located at http[s]://<host-name>:<port>/<application name>/rest. 

  E.g. http://demo.openspecimen.org/openspecimen/rest/ng/collection-protocols/1/workflows

  
  

• You request a particular resource by appending a particular path to this base URL
• All resources may return any of the below mentioned status codes:

...

On this page, when a portion of a URL, path, or parameter value is shown in italics, it indicates that you should replace the italicised value with a particular value appropriate to your request.

Authentication

OpenSpecimen REST API's are signed requests, accessible to all the users who has access to OpenSpecimen application. To access the REST API's user need to pass their OpenSpecimen credentials by setting them in request Authorization header. The username/password should be encoded in base 64 encoding scheme.

Unauthenticated APIs

Given below is list of APIs that do not require user authentication

...

• Milliseconds elapsed since epoch. This mode always represents time in UTC. For example: 1487574000000 is 20th February 2017 00:00 in MDT
• Adding appropriate offset to input date/time field value. For example: 2017-02-20T06:00:00.000Z is 20th February 2017 00:00 in MDT.

...