You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

info

The data collection service is a data hub to store and retrieve JSON files for communication and synchronization of data between different services. It provides a REST API for storing and retrieving json data. Services that use the data collection service get their own secret key for secure authentication.


Overview

Status: PRODUCTIVE

Weblink: collections.gfbio.org

Target group: service provider

Keywords: data exchange, JSON, API

RDC Integration: integrated or connected

Product owner: GFBio e.V.


RDC Integration

draw.io

Source page access restriction: Click the link below to check if the page is accessible.
/display/NFDI/Mediation+Layer

The GFBio Data Collections Service is currently used to send data selected within the GFBio Data Search and transfer it to the Visualization and Analysis tool.

Getting started

You can use the Data Collection Service as an independent micro-service to exchange data between multiple services. The Data Collection Service is agnostic to the contents of the data, the only requirement is that is is formatted as a valid JSON document. Currently, the service does not provide structural or administrative metadata. A collection needs to be mapped to a user id. The service is agnostic to the type and source of the user id. Currently service providers need to agree on the format of the data and the user id format independently of the Data Collections Service.  

User Guide

The data collections service is a technical service that is intended for exchanging data in JSON format between user-facing services in RDC. As such the collection service currently only offers a REST API and no graphical or command line user interface. The primary target audience are RDC developers and service providers. Please refer to the API Documentation for details on usage.

Token-based Authentication

For another tool to access or create data via the REST API, it is required first to be registered as a service in the backend. These services are also used for permission handling. A service than can get one or multiple auth tokens consisting of a UUID. This tokens then need to be exchanged via a secure channel. For authentication the requesting service needs to send it as a header in the format "Authentication: Token {{auth_token}}".

To ensure that a token stays secret, requests must only be sent from the backend-server and never from the client directly.

Deployment Guide

Please refer to the "developer guide" section on GitHub if you plan to deploy your own instance of this service.

References

Publications

  • No labels