B2STAGE HTTP-API for EUDAT project

build	coverage	quality	uptime	swagger	feedback

Objectives

This project aims at developing a B2STAGE HTTP-API fot the EUDAT CDI. The primary goal is to allow users to ingest and retrieve data via a standard RESTful HTTP interface in order to:

hide the underlying technology from users,
lower the entry barrier to using EUDAT services,
simplify integration into existing workflows,
allow direct access to data assets held with the EUDAT CDI.

Documentation

The first stable release is focused on the interaction with the B2SAFE service, allowing users to transfer and manage data on the registered domain.

Get started

try a quick start
see the latest webinar
a demo prototype of the current functionalities

User guide

use an existing instance of the HTTP-API
main authentication based on B2ACCESS
alternative authentication based on B2SAFE
endpoints description and examples

Administration

read the pre-requisites prior to installation
startup a working copy
deploy in two modes
define the authentication mechanism to be applied
debug the server operating on top of B2SAFE and fix eventual issues
keep your server up-to-date

Development

add new features
extra operations

Implementation

This project is based on the open-source RAPyDo framework.

The API server is implemented with the latest Python 3 release using the Flask core. To facilitate and speed the development Docker is the base environment to automate the creation and configuration of the software stack needed. The API interconnects with EUDAT services’ native APIs or libraries.

To exchange data and metadata within the B2SAFE service (built on iRODS system as backend storage) the interface is implemented using (and contributing to) the official python-irodsclient.

NOTE: the B2STAGE HTTP-API is an interface towards other EUDAT services which are subject to modifications and new developments, therefore the functionalities and the implementation will have to be changed accordingly.

http-api