API introduction

This version of SEEK includes a JSON Application Programming Interface (API) that allows the searching, listing and reading of assets described in SEEK, as well as their attributes. The API is described on SwaggerHub where the API can also be tested out.

The API conforms to the JSON API specification which describes a standard way of representing APIs in JSON.

Authentication

Calls to the JSON API should use Basic Authentication (base64 encoding of username and password). This identifies the “logged in” user to SEEK. The API only exposes those assets to which that user has access. As a result, the results of a call will vary according to which user is logged in.

The JSON API can also be used without any authentication, in which case only publicly viewable information will be returned.

Excluded assets

The JSON API currently allows the searching, listing and reading of all types of assets except the reading of

  • an individual Sample Type
  • Samples
  • Strains

Future work

The SEEK team are currently working on extending the API to include create, update and delete capabilities as well as to cover currently excluded assets and attributes.