API Methods in myDRE

API Methods in myDRE

Choosing Between API Key Management for Users in myDRE and Data Upload API (also referred to as Data Landing Zone).

In myDRE, there are now two distinct methods for uploading data into workspaces using APIs. While they both allow secure file transfers, the key difference lies in how authentication and permissions are managed. Choosing the right one depends on your use case, access level, and whether the data upload is automated or user-driven.
This article will help you understand the differences, decide which method to use, and easily navigate to the detailed documentation of each.

1. API Key Management for Users in myDRE

This is the recommended and most secure method for users who actively work in a workspace and want to upload data using a personal API key. Use this method if you're an active user of a workspace and want control over your API access.
  1. Keys are tied to your user account.
  2. You can generate and manage your key yourself.
  3. Keys automatically expire when you lose workspace access or your account is deactivated.
  4. Uploads are traceable (your myDRE user name is attached to uploaded data).
Read the full article on API Key Management for Users in myDRE

2. Data upload API (also referred to as Data Landing Zone)

Data Upload API is a more traditional and flexible method, designed for use cases where automation or external systems need to upload data to a workspace without being a member of it. Use this method if you are setting up external or automated uploads, or need to allow non-members to submit data.
  1. Authentication is done via two API keys:
    1. A Subscription key (shared across all workspaces in the Azure subscription) and requested to your local Research Support
    2. A Workspace API key (specific to each workspace)
  2. This method does not tie uploads to a specific user.
  3. Keys must be managed securely and manually revoked if compromised.
  4. Suitable for external scripts, apps, or pipelines that must deliver data without a user account.
Read the full article on Data Landing Zone (DLZ)

Which One Should You Use?

You may need both, depending on the context:
  1. Use API Key Management for Users when you are uploading and want secure, traceable access.
  2. Use Data Upload API when a system or someone external needs to push data to your workspace.
Both methods can coexist and serve different purposes. However, note that:
Notes
The Subscription Key used in Data Upload API is not the same as the user-specific key used in API Key Management. They are not interchangeable.

When uploading files:

  1. API Key Management logs the user who uploaded the file.
  2. Data Upload API uploads appear without user identity, as they're based on shared keys.
Alert
Always treat API keys like passwords. Store them securely and never share them in public scripts or messages.

    • Related Articles

    • API Key Management for Users in myDRE

      Having control over your API access is crucial for maintaining security and independence. In myDRE, users can now manage their own API keys, enabling them to upload data into workspaces with a single key. This provides greater flexibility and ...

    • Roles in myDRE workspace

      Roles are defined per workspace. A myDRE user can have different roles in different workspaces they are part of. Each workspace member can have one of these specified roles within that workspace: Accountable The Accountable is the responsible person ...

    • CEDAR

      CEDAR Home page CEDAR https://more.metadatacenter.org/tools-training/orientation CEDAR APIs https://more.metadatacenter.org/tools-training/cedar-api CEDAR API and Python Prerequisites: Create file called: secret.py Add the following line of ...

    • Federated Learning on myDRE with VANTAGE6

      VANTAGE6 An open source privacy preserving Federated Learning Infrastructure for Secure Insight Exchange. ARCHITECTURE VANTAGE6 uses a client-server model, which is shown in the figure below. In this scenario, the researcher can pose a question and ...

    • myDRE - why

      Why myDRE was created in <1.5 minutes For more information From organization perspective anDREa FAQ From user perspective myDRE Or contact a colleague: Pascalle Broer