Technische Schnittstellen (APIs)

Innerhalb der Quellenedition sind mehrere Schnittstellen für einen programmierenden bzw. maschinengestützten Zugriff auf die STURM-Forschungsdaten implementiert.

URI-Resolver

Alle Entitäten der Edition (Quellen, Personen, Orte, Werke etc.) sind mittels persistenter Identifikatoren (URIs) dauerhaft referenziert. Hierbei steht ein URI für die abstrakte digitale Ressource innerhalb der STURM-Edition, die in verschiedene konkrete Repräsentationen aufgelöst werden kann.

Beispiel: https://sturm-edition.de/id/Q.01.19140115.FMA.01

Für jeden URI ist ein Resolving mittels Content Negotiation implementiert, über das verschiedene Formate (Repräsentationen) einer Ressource innerhalb der STURM-Edition bezogen werden können. Dazu sendet der Client beim Aufruf eines URI einen Accept-Header mit dem gewünschten Format (entweder text/html, application/xml oder application/json). Der Resolver leitet auf Basis des Accept-Header die Anfrage zur jeweiligen URL weiter, unter der sich die formatspezifische Version der Ressource (HTML, XML, JSON) befindet. Hierbei sendet der Resolver den Status-Code 302 Found sowie einen Location-Header mit der jeweiligen Ziel-URL. Sendet der Client keinen Accept-Header wird HTML als Standardformat für die jeweilige Ressource angenommen.

Datenschnittstelle (XML/JSON)

Über die Datenschnittstelle lassen sich sämtliche Text- und Registerdaten der Edition als TEI/XML oder TEI/JSON beziehen. Der Einstiegspunkt für diese API befindet sich unter folgender Adresse:

https://sturm-edition.de/api/

Die Schnittstelle orientiert sich an den Prinzipien der API Evolution und bietet stabile, unveränderliche Auslieferungspunkte. Diese implementieren Content Negotiation und können entweder – je nach dem vom Client gesendeten Accept-Header TEI/XML oder JSON ausliefern (application/xml oder application/json). Unterhalb des übergeordneten API-Einstiegspunktes stehen momentan die folgenden fünf Auslieferungspunkte zur Verfügung:

                    
/api/
      letters
             /Q.01.19140115.FMA.01
      places
             /O.0000009
      persons
             /P.0000021
      works
             /W.0000066
      files
             /Q.01.19140115.FMA.01.xml
             /schnittstellen.xml
                    
                

Über letters, places, persons und works lassen sich die Registerinformationen zu den Künstlerbriefen, Orten, Personen und Werken abrufen. Jeder Register-Einstiegspunkt liefert einen Ressourcenindex (in TEI/XML oder JSON) mit einigen Kopfinformationen zur jeweiligen Ressource aus. Im Falle der Briefe sind dies beispielsweise eine jahresweise Zuordnung zu Künstlern und Künstlerinnen, die Brief-Identifikatoren, die zugehörigen XML-Dateien sowie das Absendedatum mit Ort. Im Falle von Orten, Personen und Werken sind dies neben den Identifikatoren bspw. auch die Norm- und Geodaten sowie die Zuordnungen, in welchen Quellen die jeweiligen Personen, Orte oder Werke genannt werden. Über den Identifikator jeder Ressource lassen sich auf der letzten Hierarchie-Ebene der API die einzelnen Ressourcen abrufen.

Eine Besonderheit stellt der files Einstiegspunkt dar. Über ihn kann jede XML-Datei der STURM-Edition im TEI/XML-Volltext bezogen werden. Neben den einzelnen Quellen zum Beispiel auch die Begleittexte. Nachfolgend einige Linkbeispiele für die oben beschriebenen Auslieferungspunkte:

Typ URL
Brief https://sturm-edition.de/api/letters/Q.01.19140115.FMA.01
Ort https://sturm-edition.de/api/places/O.0000009
Person https://sturm-edition.de/api/persons/P.0000021
Werk https://sturm-edition.de/api/works/W.0000066
Datei https://sturm-edition.de/api/files/Q.01.19140115.FMA.01.xml

BEACON-Datei

Sämtliche in der Edition vorhandenen und mit GND-Normdaten referenzierten Entitäten (Personen, Werke) können über BEACON-Dateien abgerufen werden. Die BEACON-Datei für Personen ist auch innerhalb des BEACON-Findbuch Service registriert, die STURM-Personen lassen sich mittels dieses Webservices als „seeAlso“ Informationen in eigene Webangebote einbinden.

BEACON Personen: https://sturm-edition.de/beacon/personen.txt
BEACON Werke: https://sturm-edition.de/beacon/werke.txt

CMIF-Datei

Über die CMIF-Datei können die Metadaten der STURM-Künstlerbriefe im Correspondence Metadata Interchange Format (CMIF) abgerufen werden. Die Schnittstelle dient vor allem der Einbeziehung der STURM-Briefe in den Webservice correspSearch der Berlin-Brandenburgischen Akademie der Wissenschaften. Mit correspSearch können Verzeichnisse digitaler und gedruckter Briefeditionen nach Absender, Empfänger, Schreibort und -datum übergreifend durchsucht werden.

URL: https://sturm-edition.de/cmif/corresp.xml