Schnittstellen

Nutzer*innen können mithilfe der offenen API der Deutschen Digitalen Bibliothek eigene Anwendungen wie Webseiten oder Apps entwickeln. Durch die API überlässt die Deutsche Digitale Bibliothek ihren Nutzer*innen die Entscheidung, wie, wo und in welchen Kontexten die Daten der in der Deutschen Digitalen Bibliothek vertretenen Kultur- und Wissenschaftseinrichtungen verwendet werden.

Für die Nutzung des APIs der Deutschen Digitalen Bibliothek ist noch eine Authentifikation in Form eines Schlüssels (API-Key) notwendig. Ein Authentifikationsschlüssel ist eine dem Nutzer eindeutig zugeordnete Zeichenfolge, die bei jeder Anfrage an die API zum Zwecke der Authentifikation mitzuübertragen ist. Alle registrierten Nutzer*innen der Deutschen Digitalen Bibliothek können sich einen Authentifikationsschlüssel für die Verwendung der APIs erzeugen lassen. Dies erfolgt über das eigene Nutzerkonto im Bereich Meine DDB.

Eine ausführliche Dokumentation in Form einer OpenAPI-Spezifikation steht unter https://api.deutsche-digitale-bibliothek.de/OpenAPI/ bereit.

Beispiele für Anwendungen, die auf der API der Deutschen Digitalen Bibliothek basieren:

• Archivportal-D
• Projekte beim Kultur-Hackathon Coding da Vinci

Wenn Sie Anbieter von Anwendungen sind, die auf die API der Deutschen Digitalen Bibliothek zugreifen, benutzen Sie bitte das API-Logo der Deutschen Digitalen Bibliothek. Das API-Logo der Deutschen Digitalen Bibliothek steht in den Farbstellungen rot, grau, schwarz in verschiedenen Formaten und in englischer Version zur Verfügung.

Das Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH 2.0-Spezifikation) ist eine Datenschnittstelle für das einfache Einsammeln (Harvesting) von Metadaten. OAI-PMH wurde entwickelt, um eine Infrastruktur aufzubauen, die das Übertragen großer Mengen an verstreuten Metadaten ermöglicht.

Die Deutsche Digitale Bibliothek kann Daten von OAI-PMH-Server harvesten, also systematisch herunterladen. Dies ist ein Weg, wie Datenpartner ihre Metadaten an die Deutsche Digitale Bibliothek liefern können. Außerdem stellt die Deutsche Digitale Bibliothek ihre eigene OAI-PMH-Schnittstelle zur Verfügung. Diese wird grundsätzlich für die Weitergabe von Datensets an Europeana eingesetzt.

Die OAI-PMH-Schnittstelle unterstützt aktuell die Metadatenformate „ddb“ – das Internformat der Deutschen Digitalen Bibliothek, das alle zur Verfügung stehenden Informationen eines Objektes (exkl. der ursprünglich gelieferten Metadaten) enthält –, das bei OAI-PMH verpflichtenden „oai_dc“ (OAI-Dublin Core-Format) und für die Weitergabe an Europeana das „edm“ (Europeana Data Model). Die Schnittstelle bietet die folgenden sog. Verben, mit deren Hilfe Daten abgefragt werden können:

• GetRecord: Abfragen eines einzelnen Objektes mithilfe eines Identifiers
• Identify: Abfragen grundsätzlicher Informationen über den Provider, hier die Deutsche Digitale Bibliothek
• ListIdentifiers: Abfragen mehrerer Objekt-Informationen (z.B. Identifier)
• ListMetadataFormats: Abfrage verfügbarer Metadatenformate (oai_dc, edm, ddb)
• ListRecords: Abfragen mehrerer Objekte
• ListSets: Abfragen vorhandener Datensets Die Datensets (ListSets) sind wie folgt gebildet.

Zum Harvesting von Daten über die OAI-PMH-Schnittstelle der Deutschen Digitalen Bibliothek empfiehlt sich grundsätzlich folgende Strategie (Am Beispiel des Sets mit dem Identifier „30220325038178414olvD“.):

1. Abfrage aller Objekte über Verb ListIdentifiers:
   ?verb=ListIdentifiers&metadataPrefix=edm&set=30220325038178414olvD
2. Iteration über alle OAI-Identifiers mit GetRecord:
   ?verb=GetRecord&metadataPrefix=edm&identifier=4MQ3WL64DWF2AHA3M3B5YUDOFMWMEMAH