Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Section
Column

Einführung

Das Application Programming Interface (API) ist eine Programmierschnittstelle, die den Zugriff auf Daten und Methoden der Deutschen Digitalen Bibliothek (DDB) ermöglicht. Sie erlaubt die Entwicklung vielfältiger Anwendungen, die die in der DDB vorgehaltenen Inhalte nutzen und sie jeweils nach den eigenen Wünschen darstellen und in unterschiedliche Kontexte einbetten. Das API steht allen Personen offen.

Für die Nutzung des Application Programming Interfaces der Deutschen Digitalen Bibliothek ist 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 das API zum Zwecke der Authentifikation mit zu übertragen ist. Authentifikationsschlüssel sind vertraulich und ausschließlich für die Verwendung durch den Nutzer bestimmt. Sie dürfen nicht an Dritte weitergegeben werden, es sei denn mit ausdrücklicher schriftlicher Zustimmung der DDB.

Column
width30%
Noprint
Panel
titleInhalt dieser Seite

Table of Contents
maxLevel2

Registrierung

Jeder registrierte Benutzer der Deutschen Digitalen Bibliothek kann einen Authentifikationsschlüssel für die Verwendung des APIs beantragen. Dies erfolgt über das Profil im Bereich „Meine DDB“. Den Nutzungsbedingungen muss jeder, an einem API Key interessierte Nutzer zustimmen.

Schritte zum API Key

  1. Zunächst ist es notwendig sich ein ordentliches Konto in der Deutschen Digitalen Bibliothek anzulegen. Die Anmeldung über einen OpenID-Service (Google oder Yahoo) ist nicht ausreichend.
  2. Wenn Sie sich in der Deutschen Digitalen Bibliothek anmelden, können Sie nun im Bereich „Meine DDB“ und „Konto“ im rechten Menü „API-Zugang“ auswählen.
  3. Sobald Sie den Nutzungsbestimmungen zugestimmt haben, wird Ihnen ihr persönlicher API Key angezeigt.

Lizenz

Über das API der Deutschen Digitalen Bibliothek werden ausschließlich CC0-lizenzierte Metadaten ausgegeben. Somit unterscheidet sich der über das API ausgegebene Datenbestand von dem im Portal der Deutschen Digitalen Bibliothek, da nicht alle darin enthaltenen Metadaten unter CC0 gestellt wurden.

Feedback

Ein Feedback zum API bzw. zur Benutzung des API ist sehr willkommen und kann an feedback@deutsche-digitale-bibliothek.de gerichtet werden. Das öffentliche API steht in einer Beta-Version zur Verfügung. Zu einem späteren Zeitpunkt ist die Veröffentlichung einer weiterentwickelten Version vorgesehen, in die auch Rückmeldungen aus dem Nutzerkreis einfließen sollen. Dasselbe gilt für die Dokumentation des API.

Benutzung des API

Das API der Deutschen Digitalen Bibliothek bietet ausschließlich lesenden Zugriff. Über die folgenden 15 Methoden können die unterschiedlichen Daten und -bestandteile abgerufen werden. Die Dokumentation der API-Methoden wurde, abweichend von der übrigen Dokumentation und wie allgemein in Entwickler-Gemeinschaften üblich, in englischer Sprache verfasst.

Children Display
pageMethoden
excerpttrue
depth2

Datenmodell

Das Datenmodell der Deutschen Digitalen Bibliothek ist im entsprechenden Abschnitt des Wikis dokumentiert.

Vokabular

Das verwendete Vokabular wird im entsprechenden Abschnitt des Datenmodells dokumentiert. Zur Zeit verwendet die Deutsche Digitale Bibliothek das folgende spezifische Vokabular in ihrem Datenmodellen.

Children Display
pageVokabular
excerpttrue
depth1