docuteam box

docuteam box ist sowohl Benutzer-Schnittstelle als auch eine API, die auf einem Fedora-Repository-Stack aufsetzt. Sie bietet high-level Funktionen für den Zugriff auf die Objekte im digitalen Magazin. Es können bspw. "Dissemination Information Packages" (DIP) in unterschiedlicher Form erstellt, Vorschauen für spezifische Objekte erzeugt oder die umfassenden Metadaten abgefragt werden.

Die Applikation bietet sowohl eine graphische Benutzer-Oberfläche als auch eine API für automatisierte Aufrufe.

• Das GUI bietet ein Cockpit auf das Repository, d.h. eine statistische Übersicht über dessen Inhalt, eine SPARQL-Suche sowie eine einfache Suche.
• Das API unterstützt dieselben zentralen Funktionen für den Zugang auf Repository-Objekte wie das der Vorgänger docuteam rservices, mit drei Abweichungen:
  • Authentifizierung findet über X-Auth-token HTTP header statt
  • Die Erstellung von DIPs auf Basis von mitgelieferten EAD oder generischen XML-Dateien wird nun synchron bearbeitet, d.h. die Antwort der Funktion liefert direkt das DIP zurück, nicht nur den zu erwartenden Dateinamen.
  • Zusätzliche Operation zum Herunterladen der mets.xml-Datei eines DIPs ohne die eigentlichen Dateien
• Darüber hinaus unterstützt die API auch Operationen zum Ingest von SIPs in Fedora 6 (durch Senden eines Pfades zu einem SIP) und zum Ersetzen vorhandener Dateien in Fedora (durch Senden eines Pfads zu einem Binary und den dazugehörigen RDF-Metadaten).

Die technische API-Dokumentation in Form ein OpenAPI-Spezifikation is innerhalb der laufenden Applikation unter ./docs/v1 verfügbar, oder hier.

Für die Authentifizierung gibt es zwei Varianten in docuteam box:

• Die graphische Benutzeroberfläche benutzt eine Keycloak-Instanz, die entweder direkt die Authentifizierung übernimmt oder alternativ mit existierenden Mechanismen über OpenID or SAML verknüpft werden kann.
• Die API erwartet Tokens, die über die graphische Oberfläche verwaltet werden können.