Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

Die Online-Schnittstelle zur ExpoDB wird mit dem Protokoll https angesprochen. Es wird jeweils eine Testinstallation unter der Domain expotest.bsz-bw.de eingerichtet und, sobald die Grundkonfigura­tion in der Teststellung passt, eine Produktivinstallation unter expo.bsz-bw.de. Die Anwendungen, die die ExpoDB nutzen, sollen mit ihren produktiven Instanzen möglichst bald auf die Produktivinstal­lation unter expo.bsz-bw.de wechseln: Dies erlaubt auf der Testinstanz die Entwicklung der ExpoDB weiterzutreiben. Dabei kann es vorkommen, wobei dort vorkomen kann, dass der Service aufgrund von Fehlern oder Wartungs­zeiten unterbrochen ist. Der Im Gegensatz dazu ist der Betrieb der Produktivinstanz ist stabiler, Wartungszeiten werden hier jeweils vorab angekündigt. Es wird empfohlen, auch für die Anwendungen, die die Schnittstelle nut­zen, jeweils eine Teststellung einzurichten. Diese sollte , die auf expotest.bsz-bw.de konnektiert werden wird und es erlaubt es, die Schnittstelle seitens der Bereitstellung und der Verwendung zu testen.

Für die folgenden Beispiele wird die Domäne Produktivinstallation expo.bsz-bw.de verwendet. Nach der Domänenangabe folgen die URL-Komponenten, die die anwendungsspezifische Installation der Schnittstelle bezeich­nen. Sie bestehen in der Regel aus einem dreistelligen Kürzel des Museums, z.B. sgs, smf, etc., sowie einer Bezeichnung der Teilsammlung bzw. intendierten Anwendung, z.B. sammlung-online oder digi­taler-katalog. Insgesamt ergibt sich bis dahin also z.B. https://expo.bsz-bw.de/sgs/digitaler-katalog. Dann folgen die Methoden der Schnittstellen /selekt, /image etc. und schließlich der durch „?“ abge­trennte Querystring. Die URL-Parameter werden im Querystring der URL als name=value-Paare ko­diert, die mit "&" getrennt sind und deren Reihenfolge nicht signifikant ist. Zur Darstellung von reser­vierten Zeichen (z.B. Leerzeichen) und Sonderzei­chen ist ein URL-Encoding der Parameterwerte er­forderlich.

Jede Installation ist mit einem Basis-Format konfiguriert, das ausgeliefert wird, sofern kein fmt-Parameter angegeben wird. Alternative Formate können mit dem URL-Parameter "fmt" angegeben werden. Welche zusätzlichen Formate für eine Schnittstelle eingerichtet und angeboten werden, wird für jede Installation verabredet und mitgeteilt.

Mit dem optionalen URL-Parameter „mim“ "mim" oder dem http-Accept-Header, die „application"application/xml“ xml" oder „application"application/json“ json" annehmen können, wird festgelegt, in welcher Syntax, XML bzw. JSON, das Ergeb­nis aufbereitet und mit welchem Mimetype es ausgeliefert wird. Vorgabewert ist „application"application/xml“xml".

Mit einem URL-Parameter "dld" kann ein Dateiname übergeben werden, der bewirkt, dass Browser das Resultat zum Download unter diesem Dateinamen anbieten.

...