DER STURM

Tech­ni­sche Schnitt­stel­len (APIs)

In­ner­halb der Quel­len­edi­ti­on sind meh­re­re Schnitt­stel­len für einen pro­gram­mie­ren­den bzw. ma­schi­nen­ge­stütz­ten Zu­griff auf die STURM-​Forschungsdaten im­ple­men­tiert.

URI-​Resolver

Alle En­ti­tä­ten der Edi­ti­on (Quel­len, Per­so­nen, Orte, Werke etc.) sind mit­tels per­sis­ten­ter Iden­ti­fi­ka­to­ren (URIs) dau­er­haft re­fe­ren­ziert. Hier­bei steht ein URI für die abs­trak­te di­gi­ta­le Res­sour­ce in­ner­halb der STURM-​Edition, die in ver­schie­de­ne kon­kre­te Re­prä­sen­ta­tio­nen auf­ge­löst wer­den kann.

Bei­spiel: https://sturm-​edition.de/id/Q.01.19140115.FMA.01

Für jeden URI ist ein Re­sol­ving mit­tels Con­tent Nego­tia­ti­on im­ple­men­tiert, über das ver­schie­de­ne For­ma­te (Re­prä­sen­ta­tio­nen) einer Res­sour­ce in­ner­halb der STURM-​Edition be­zo­gen wer­den kön­nen. Dazu sen­det der Cli­ent beim Auf­ruf eines URI einen Accept-Header mit dem ge­wünsch­ten For­mat (ent­we­der text/html, application/xml oder application/json). Der Re­sol­ver lei­tet auf Basis des Accept-Header die An­fra­ge zur je­wei­li­gen URL wei­ter, unter der sich die for­mat­spe­zi­fi­sche Ver­si­on der Res­sour­ce (HTML, XML, JSON) be­fin­det. Hier­bei sen­det der Re­sol­ver den Status-​Code 302 Found sowie einen Location-Header mit der je­wei­li­gen Ziel-​URL. Sen­det der Cli­ent kei­nen Accept-Header wird HTML als Stan­dard­for­mat für die je­wei­li­ge Res­sour­ce an­ge­nom­men.

Da­ten­schnitt­stel­le (XML/JSON)

Über die Da­ten­schnitt­stel­le las­sen sich sämt­li­che Text- und Re­gis­ter­da­ten der Edi­ti­on als TEI/XML oder TEI/JSON be­zie­hen. Der Ein­stiegs­punkt für diese API be­fin­det sich unter fol­gen­der Adres­se:

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

Die Schnitt­stel­le ori­en­tiert sich an den Prin­zi­pi­en der API Evo­lu­ti­on und bie­tet sta­bi­le, un­ver­än­der­li­che Aus­lie­fe­rungs­punk­te. Diese im­ple­men­tie­ren Con­tent Nego­tia­ti­on und kön­nen ent­we­der – je nach dem vom Cli­ent ge­sen­de­ten Accept-Header TEI/XML oder JSON aus­lie­fern (application/xml oder application/json). Un­ter­halb des über­ge­ord­ne­ten API-​Einstiegspunktes ste­hen mo­men­tan die fol­gen­den fünf Aus­lie­fe­rungs­punk­te zur Ver­fü­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 las­sen sich die Re­gis­ter­in­for­ma­tio­nen zu den Künst­ler­brie­fen, Orten, Per­so­nen und Wer­ken ab­ru­fen. Jeder Register-​Einstiegspunkt lie­fert einen Res­sour­cen­in­dex (in TEI/XML oder JSON) mit ei­ni­gen Kopf­in­for­ma­tio­nen zur je­wei­li­gen Res­sour­ce aus. Im Falle der Brie­fe sind dies bei­spiels­wei­se eine jah­res­wei­se Zu­ord­nung zu Künst­lern und Künst­le­rin­nen, die Brief-​Identifikatoren, die zu­ge­hö­ri­gen XML-​Dateien sowie das Ab­sen­de­da­tum mit Ort. Im Falle von Orten, Per­so­nen und Wer­ken sind dies neben den Iden­ti­fi­ka­to­ren bspw. auch die Norm- und Geo­da­ten sowie die Zu­ord­nun­gen, in wel­chen Quel­len die je­wei­li­gen Per­so­nen, Orte oder Werke ge­nannt wer­den. Über den Iden­ti­fi­ka­tor jeder Res­sour­ce las­sen sich auf der letz­ten Hierarchie-​Ebene der API die ein­zel­nen Res­sour­cen ab­ru­fen.

Eine Be­son­der­heit stellt der files Ein­stiegs­punkt dar. Über ihn kann jede XML-​Datei der STURM-​Edition im TEI/XML-​Volltext be­zo­gen wer­den. Neben den ein­zel­nen Quel­len zum Bei­spiel auch die Be­gleit­tex­te. Nach­fol­gend ei­ni­ge Link­bei­spie­le für die oben be­schrie­be­nen Aus­lie­fe­rungs­punk­te:

BEACON-​Datei

Sämt­li­che in der Edi­ti­on vor­han­de­nen und mit GND-​Normdaten re­fe­ren­zier­ten En­ti­tä­ten (Per­so­nen, Werke) kön­nen über BEACON-​Dateien ab­ge­ru­fen wer­den. Die BEACON-​Datei für Per­so­nen ist auch in­ner­halb des BEACON-​Findbuch Ser­vice re­gis­triert, die STURM-​Personen las­sen sich mit­tels die­ses Web­ser­vices als „see­Al­so“ In­for­ma­tio­nen in ei­ge­ne Web­an­ge­bo­te ein­bin­den.

BE­A­CON Per­so­nen: https://sturm-​edition.de/be­a­con/per­so­nen.txt
BE­A­CON Werke: https://sturm-​edition.de/be­a­con/werke.txt

CMIF-​Datei

Über die CMIF-​Datei kön­nen die Me­ta­da­ten der STURM-​Künstlerbriefe im Cor­re­spon­dence Me­ta­da­ta In­ter­chan­ge For­mat (CMIF) ab­ge­ru­fen wer­den. Die Schnitt­stel­le dient vor allem der Ein­be­zie­hung der STURM-​Briefe in den Web­ser­vice cor­res­pSe­arch der Berlin-​Brandenburgischen Aka­de­mie der Wis­sen­schaf­ten. Mit cor­res­pSe­arch kön­nen Ver­zeich­nis­se di­gi­ta­ler und ge­druck­ter Brie­fe­di­tio­nen nach Ab­sen­der, Emp­fän­ger, Schreib­ort und -​datum über­grei­fend durch­sucht wer­den.

URL: https://sturm-​edition.de/cmif/cor­resp.xml