API Dokumentation
Inhaltsverzeichnis
http/https
Die Seiten der WeGA werden seit 2018 nur noch über verschlüsseltes https ausgeliefert.
Anfragen via http werden nach https umgeleitet.
Die folgenden URL-Beispiele gelten somit immer für beide Protokolle.
Ausgabeformate und Content Negotiation
Via Content Negotiation lassen sich zu einer Ressource verschiedene Ausgabeformate wählen. Aktuell werden HTML, TEI-XML, JSON-LD und Plain Text unterstützt, wobei das gewünschte Ausgabeformat entweder über ein Suffix oder über den HTTP Accept Header angegeben werden kann. Wird beides angegeben, hat das Suffix Vorrang. NB: Die Plain-Text-Ausgabe ist als experimentelles Feature zu verstehen!
| Format | Suffix | Accept Header |
|---|---|---|
| HTML | .html, .htm |
text/html, application/xhtml+xml |
| TEI XML | .tei, .xml |
application/xml, application/tei+xml |
| Plain Text | .txt |
text/plain |
| JSON-LD | .jsonld |
application/ld+json |
Die persistente URL jeder Ressource setzt sich dabei aus der Domäne „weber-gesamtausgabe.de“ und der ID zusammen.
Beispiele mit curl
# curl -L https://weber-gesamtausgabe.de/A002068.xml
# curl -L https://weber-gesamtausgabe.de/A002068.html
# curl -L -H "Accept: text/html" https://weber-gesamtausgabe.de/A002068
# curl -L -H "Accept: application/xml" https://weber-gesamtausgabe.de/A002068
Bitte beachten Sie, dass der Parameter -L hier benötigt wird, da ggf. eine Weiterleitung erfolgt
und dass zwingend die Angabe des gewünschten Ausgabeformats (via Suffixnotation oder HTTP Accept Header) erforderlich ist.
TEI-Ausgabeformate
Wird eine TEI-Datei abgerufen (siehe Content Negotiation), so wird diese standardmäßig im WeGA-TEI-Format ausgeliefert.
Dieses Format ist eine „TEI-Customization“ und dokumentiert unter https://github.com/Edirom/WeGA-ODD.
Alternativ kann über den URL-Parameter format auch eine Ausgabe kompatibel zu „TEI all“ (format=tei_all)
oder „TEI simplePrint“ (format=tei_simplePrint) gewählt werden.
Beispiele mit curl
# curl -L "https://weber-gesamtausgabe.de/A002068.xml?format=tei_all"
# curl -L -H "Accept: application/xml" "https://weber-gesamtausgabe.de/A002068?format=tei_simplePrint"
Siehe auch die News vom 29. November 2017 zu „alternativen TEI-Ausgabeformaten“.
Sprachauswahl
Die HTML-Ausgabe der Ressourcen kann in mehreren Sprachen (Aktuell Deutsch und Englisch) erfolgen.
Dabei werden allerdings nur die Navigations- und Menüelemente übersetzt, nicht jedoch die eigentlichen Texte!
Die Sprachwahl erfolgt über eine URL-Pfadkomponente, de für Deutsch und en für Englisch.
Beispiele mit curl
# curl -L https://weber-gesamtausgabe.de/de/A002068.html
# curl -L -H "Accept: text/html" https://weber-gesamtausgabe.de/en/A002068
Abfragen von GND IDs
Von der API werden aktuell GNDs vom Typ „Person“ (früher PND), „Organisation/Körperschaft“ (früher GKD),
sowie „Werk“ unterstützt,
welche über BEACON-Dateien zur Verfügung gestellt werden.
Die Adressen der BEACON-Dateien sind https://weber-gesamtausgabe.de/pnd_beacon.txt,
https://weber-gesamtausgabe.de/gkd_beacon.txt,
bzw. https://weber-gesamtausgabe.de/works_beacon.txt.
Abfragen können durch Anhängen einer gültigen GND an die Adresse https://weber-gesamtausgabe.de/de/gnd/
gemacht werden. (Zur Sprachwahl siehe oben.)
Beispiele mit curl
# curl -L -H "Accept: application/tei+xml" https://weber-gesamtausgabe.de/de/gnd/118629662
# curl -L https://weber-gesamtausgabe.de/de/gnd/118629662.jsonld
Bitte beachten Sie, dass der Parameter -L hier zwingend benötigt wird, da eine Weiterleitung erfolgt
und dass ebenfalls die Angabe des gewünschten Ausgabeformats (via Suffixnotation oder HTTP Accept Header) erforderlich ist.
Detaillierte Informationen zum BEACON-Format finden sich unter https://de.wikipedia.org/wiki/Wikipedia:BEACON .
Correspondence Metadata Interchange-Format (CMIF)
Die WeGA stellt seit Mai 2014 alle Korrespondenz-Metadaten nach dem Correspondence Metadata Interchange-Format (CMIF)
zur Verfügung. Adresse der BEACON-Datei (seit Release 4.8): https://weber-gesamtausgabe.de/cmif_v1.xml.
Die alte URL https://weber-gesamtausgabe.de/correspDesc.xml ist aktuell noch gültig,
sollte aber nicht mehr benutzt werden und kann in einem der nächsten Releases entfernt werden.
Mit dem Release 4.8 wurde auch ein Endpunkt für das (noch im Entwurfsstadium befindliche)
CMIF v2 unter https://weber-gesamtausgabe.de/cmif_v2.xml eingerichtet. Von den Erweiterungen in CMIF v2 werden
hier aktuell nur cmif:mentionsPerson und cmif:mentionsPlace unterstützt.
Detaillierte Informationen zum CMI-Format finden sich auf den Seiten des correspSearch Webservice und unter https://github.com/TEI-Correspondence-SIG/CMIF . Siehe auch die News vom 7. Mai 2014 zur ersten Einrichtung eines „experimentellen Corresp-Beacon“.
International Image Interoperability Framework (IIIF)
Die WeGA stellt die digitalen Faksimiles, die sie selber hosten und veröffentlichen darf,
nach dem IIIF-Standard zur Verfügung.
Die Metadaten der einzelnen Bilder (info.json) werden dabei von dem bei uns eingesetzten
Digilib-Imageserver
automatisch erzeugt, und die „Resource Structure“ für die IIIF Presentation API (manifest.json)
wird aus den TEI-Dokumenten durch die WeGA-WebApp generiert.
Die persistente URL jeder Ressource setzt sich dabei aus der Domäne „weber-gesamtausgabe.de“ und dem Pfad „/IIIF/$ID/manifest.json“ zusammen.
Beispiele mit curl
# curl -L -H "Accept: application/json" https://weber-gesamtausgabe.de/IIIF/A040709/manifest.json
Swagger OpenAPI
Die WeGA bietet unter https://weber-gesamtausgabe.de/api/v1/ ebenfalls eine REST-Schnittstelle nach der Swagger OpenAPI Spezifikation 3.0 an. Diese Schnittstelle soll ein schnelles und komfortables Auffinden von Dokumenten aus der digitalen Edition ermöglichen.
