| Table of Contents |
|---|
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
...
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 schemeAPIs can be invoked only by authenticated users. There are two ways to authenticate:
- Basic authorisation using HTTP Authorization header. This can be used only for authentication of "openspecimen" domain (default domain) users. The "Authorization" header value needs to be encoded in base64.
- Using sessions API to authenticate and passing the token returned by the API in every API invocation request header.
Unauthenticated APIs
Given below is list of APIs that do not require user authentication
...