Access to datasets shared via the Human Data Gateway

You can now browse KnowledgeGraph datasets through the data proxy as an authenticated user via the datasets API: https://data-proxy.ebrains.eu/api/docs#/datasets

To get access to datasets protected by the HDG, use the datasets/{dataset_id} endpoint.

1. First perform a POST /datasets/{dataset_id} request to start the HDG flow.
2. An e-mail is then sent to the user with the terms of use to validate the access.
3. Once the access has been validated, the user is redirected by default to the KnowledgeGraph page of the dataset. This redirection can be customized for third-party integration.

Note: For publicly available datasets,  the datasets/{dataset_id} endpoint can be used via GET, without the extra validation round.

Example of programmatic integration for a third party

1. A user wants to access a KG dataset in your third-party application.
2. The third-party application calls GET /datasets/{dataset_id} with the user token in order to get information about the dataset or download it.
   1. The dataset is not protected --> A successful response is sent.
   2. The dataset is protected --> A 401 response is sent back. In the 401 json response, a can_request_access field is specified. If true, it means that it is possible to request access to that dataset using POST /datasets/{dataset_id}.
3. The third-party application asks the user if they want to request access, and then sends POST /datasets/{dataset_id}?redirect_uri=https://mythirdpartyapp.eu/{dataset_id}.
4. If the request is successful, an e-mail is sent to the user.
5. Once the user has clicked on the e-mail link, access is granted and the user is redirected to https://mythirdpartyapp.eu/{dataset_id}.
6. GET /datasets/{dataset_id} now answers with successful responses.

Front-end implementation

An actual implementation of this flow is available at data-proxy.ebrains.eu/datasets/{dataset_id}.

What datasets are available?

Datasets that are released in KnowledgeGraph v2 or v3 are available.