{#
SPDX-FileCopyrightText: 2025-2026 TU Wien.
SPDX-License-Identifier: MIT
#}
{%- extends config.BASE_TEMPLATE %}
{%- set sitename = config.THEME_SITENAME %}
{%- block page_hero %}
{%- endblock page_hero %}
{%- block page_body %}
The web interface of {{ sitename }} is designed for browsing, depositing, and managing individual records.
However, many research workflows involve more than that, such as repeated queries, bulk uploads, automated pipelines, or analysis environments where switching to a browser is impractical.
For those cases, {{ sitename }} offers two methods for programmatically interacting with the repository:
A REST API for scripted access from any environment, and a VRE Repository Connector for direct integration with virtual research environments.
Without using the web interface, both provide you with reliable, authenticated access to repository data.
The REST API follows standard HTTP conventions.
Using it, you can search and retrieve records, read and update metadata, upload or download files, and manage deposits — all without going through the web interface.
Authentication is handled through personal access tokens, which you can generate from your account settings.
For the full endpoint reference and usage examples, see the API documentation.
The VRE Repository Connector allows you to access {{ sitename }} from within a virtual research environment.
Once configured, you can read and write repository data directly from your analysis environment, without manual downloads or file transfers.
This is particularly useful for keeping workflows self-contained and reproducible.
For setup instructions and supported environments, see the VRE Repository Connector page.
Programmatic access to {{ sitename }}
REST API
VRE Repository Connector
Choosing between the two
If you want to...
Use
Automate uploads, downloads, or metadata queries from a script
REST API
Access repository data from Jupyter, RStudio, etc.
VRE Repository Connector
Integrate into Snakemake/Nextflow
REST API
Work interactively without leaving your analysis platform
VRE Repository Connector
If you have questions about setting up programmatic access or run into issues, contact us through the contact page.
{%- endtrans -%} {%- endblock page_body %}