| title | API introduction |
|---|---|
| description | The JSON API that allows the searching, listing, reading, updating and creating of many items, along with their attributes. |
{{ site.seek_instance.name | default: "FAIRDOM-SEEK" }} includes a JSON Application Programming Interface (API) that allows the searching, listing, reading, updating and creating of many items in SEEK, along with their attributes.
The API conforms to the JSON API specification which describes a standard way of representing APIs in JSON.
Technical details about the JSON structures and available endpoints comes bundled with {{ site.seek_instance.name | default: "FAIRDOM-SEEK" }} and can be found served from:
http://<host>:<port>/apiFor example, on the FAIRDOMHub it is [{{ site.seek_instance.url | default: "https://fairdomhub.org" }}/api]({{ site.seek_instance.url | default: "https://fairdomhub.org" }}/api), or for a local running instance it would be http://localhost:3000/api
There are also some examples that are available as Jupyter notebook scripts. They were created for training events, and give a general overview and walk through some typical scenarios. They can be found at https://github.com/FAIRdom/api-workshop
The API supports Basic Authentication, OAuth and API Tokens.
More details can be found in [{{ site.seek_instance.name }} API Docs]({{ site.seek_instance.url | default: "https://fairdomhub.org" }}/api#section/Authentication)
The API can also be used without any authentication, in which case only publicly viewable information will be returned.