Handreichung zur Schnittstelle (API)

Zugriff auf die OAI-PMH-Schnittstelle 

Das Kulturerbe-Portal stellt eine offene Schnittstelle bereit. Dies ermöglicht die Vereinfachung der Weitergabe von Metadaten über einen festgelegten Standard zwischen verschiedenen Einrichtungen und macht die Kulturdaten bundes- und europaweit anschlussfähig. 

Die Nutzung ist kostenfrei.

Alle Metadaten stehen unter der Lizenz CC0 zur Verfügung. Alle darin verlinkten Bildinhalte stehen gemeinfrei oder unter freien Lizenzen zur Verfügung, die es zu berücksichtigen gilt.

Zugriff: 
https://kreuz-rad-loewe.de/oai

Funktionsweise

Das OAI-PMH-Protokoll (Open Archives Initiative Protocol for Metadata Harvesting) enthält sechs Basisfunktionen: Identify, ListRecords, ListIdentifiers, ListSets, GetRecord und ListMetadataFormats, die mit dem Parameter ?verb= an die Basis-URL angehängt werden.

Allgemeine Informationen zum Repository finden sich unter der ersten Basisfunktion:
https://kreuz-rad-loewe.de/oai?verb=Identify

Im Webbrowsers wird standardmäßig eine für Menschen besser lesbare HTML-Repräsentation der XML-Antwort angezeigt. Über die Browserfunktion "Seitenquelltext anzeigen" lässt sich die reine XML-Antwort betrachten.

Listen von Inhalten abrufen (ListRecords, ListIdentifiers, ListSets)

Als "Inhalte" werden im Kontext von Kreuz Rad Löwe sowohl Kulturerbeobjekte als auch Orte, Personen und Institutionen verstanden. Die Funktion ListRecords listet die Datensätze aller Inhalte auf: 
https://kreuz-rad-loewe.de/oai?verb=ListRecords&metadataPrefix=dm2e

Mit ListIdentifiers anstelle von ListRecords kann nur auf die Identifikatoren der Inhalte statt direkt auf die vollen Datensätze zugegriffen werden.

Alternativ können vordefinierte Sets als Einstieg verwendet werden. Für jede Institution existiert ein Set, welches alle zugehörigen Kulturerbeobjekte beinhaltet. Dies geschieht über die Funktion ListSets:
https://kreuz-rad-loewe.de/oai?verb=ListSets

Alle Orte und Personen befinden sich im Set mit dem Namen "Resources".

Einzelnen Inhalt abrufen (GetRecord)

Über die oben erhaltenen Listen von Datensätzen bzw. Identifikatoren kann mittels der Funktion GetRecord ein einzelner Inhalt angezeigt werden.

Beispiel:

https://kreuz-rad-loewe.de/oai?verb=GetRecord&metadataPrefix=dm2e&identifier=oai:kulturerbe.kreuz-rad-loewe.de:item:u6k:Ethnografische-Studiensammlung:43752

Resumption Token

Bei großen Datenmengen wird die Antwort auf eine Anfrage in mehrere Teilmengen aufgeteilt. Am Ende jeder Antwort wird ein Resumption Token zurückgegeben, mit dem die nächste Teilmenge abgerufen werden kann. Dies verhindert Timeouts und übermäßige Serverlast. Um die nächste Seite abzurufen, wird der erhaltene Token als Parameter verwendet:
https://kreuz-rad-loewe.de/oai?verb=ListRecords&resumptionToken=[TOKEN]

Dieser Mechanismus ermöglicht die schrittweise Abfrage (Harvesting) auch sehr großer Datenbestände.

Metadatenformate

Für jeden Datensatz stehen drei Formate zur Verfügung. Diese werden hier definiert:
https://kreuz-rad-loewe.de/oai?verb=ListMetadataFormats

dm2e: Datenformat, das aus dem Projekt Digitised Manuscripts to Europeana hervorging. Es enthält alle vorhandenen Informationen der beiden anderen Formate und geht darüber hinaus.

edm: Datenformat nach dem Europeana Data Model ohne die zusätzlichen Felder, die DM2E ermöglicht. Soweit möglich, werden passende Entsprechungen genutzt - einige Informationen entfallen.

oai_dc: Reduzierte Version nur der wichtigsten Metadaten eines Eintrags nach dem Metadatenschema Dublin Core.

Das Format wird über den Parameter ?metadataPrefix= an die URL angehängt.

Kontakt

Bei Fragen zur Nutzung wenden Sie sich gerne an uns.