Zentrumfür Nachhaltiges Forschungsdatenmanagement

Was ist HeuRest sAPI?

sAPI steht für "simple Advanced Programming Interface", also eine sehr simple API zum Abfragen der bereits angelegtetn und gepflegten Daten in einem Heurist-Projekt, das an der UHH unterhalten wird, um

• auf die in Heurist angelegten Entitäten und Digitalisate direkt und unabhängig zuzugreifen sowie
• die Daten ins FDR zu transferieren.

Warum HeuRest sAPI

• Über die REST-Schnittstelle können die Forschungsdaten aus Heurist in einer eigenen Anwendung automatisiert weiterverarbeitet werden.
• Funktionalitäten, die nicht in Heurist möglich sind, können selbst erstellt werden, wobei die Daten automatisch aktualisiert werden.
• Administration der Daten erfolgt weiterhin in Heurist. Es gibt keine Doppelungen der Daten.
• Beliebige Endpunkte können eingerichtet werden.

Verwendung aus einer eigenen Python Anwendung (empfohlen)

1. Setzen Sie einen post request mit drei Parametern ab:

   response = requests.post(endpoint auth=auth, json=data)

2. Wenn Sie keinen eigenen Endpunkt definiert haben, wählen Sie den Standardendpunkt:

   'https://heurest.fdm.uni-hamburg.de/data/entity'

3. Mit auth definieren Sie Ihre Heurist Zugangsdaten als ein Tupel:

   auth = ("Benutzername", "Passwort")

4. data enthält ein Dictionary mit den folgenden Einträgen:

   data =
       {
           "heurist_project": "Heurist-Projektname",
           "dataspec": "Records",
           "entity": "Name der Entität, weitere Entität"
       }

   Wenn Sie keinen eigenen Endpunkt definiert haben, lassen Sie den Wert "Records" unverändert, tragen aber den Namen des Heurist-Projektes und kommagetrennt die Namen der in Heurist definierten Entitäten, die abgefragt werden sollen, ein.

Verwendung über die Webschnittstelle https://heurest.fdm.uni-hamburg.de

1. Melden Sie sich über die Schaltfläche Access -- Login Page an.
2. Wählen Sie unter Services -- Transfer Data die entsprechenden Entitäten aus.
3. Wählen Sie das Format CSV oder JSON als Download aus. Es erfolgt dann ein Download im Browser als zip-Datei.
4. Falls Sie ihre Daten in das Repositorium der Universität Hamburg übertragen möchten, aktivieren Sie die Schaltfläche FDR Transfer und beachten die dann folgenden Anweisungen.