o2r web API documentation

Opening Reproducible Research

Current version of the API: v1

About

The o2r web API acts as the interface between the o2r microservices and the web interface.

The API provides services around the executable research compendium (ERC), or "compendium" for short, which is documented in the ERC spec.

General notes

The API is implemented as a RESTful API. The entrypoint for the current version is /api/v1.

Unless specified otherwise, responses are always in JSON format. Body parameters in POST requests are expected in multipart/form-data format. Requests to the API should always be made with a secure connection using HTTPS. Some requests require authentication with a specific user level.

We also provide a simple Postman collection (getpostman.com), so that you can comfortably explore the API.

License

CC-0 Button

The o2r Executable Research Compendium specification is licensed under Creative Commons CC0 1.0 Universal License, see file LICENSE. To the extent possible under law, the people who associated CC0 with this work have waived all copyright and related or neighboring rights to this work. This work is published from: Germany.