VLB-REST-API

Die VLB-REST-API ist eine Online-Schnittstelle für den Abruf von Produktdaten aus dem VLB. Über die Schnittstelle kann auf die im VLB verfügbaren Produktinformationen sowie auf zugehörige Mediendateien (z.B. Cover, Leseproben, etc.) zugegriffen werden.

Mithilfe der VLB-REST-API können Sie VLB-Daten schnell und einfach in einer Anwendung nach eigenen Vorstellungen anzeigen lassen. Als schnelle Webschnittstelle bietet sie eine direkte Recherchemöglichkeit im VLB und macht den aufwendigen Aufbau einer eigenen Artikeldatenbank überflüssig. Die VLB-REST-API eignet sich somit hervorragend zur Anbindung von Bibliographier- oder Warenwirtschaftssystemen, genauso wie für die Anbindung von Online-Anwendungen wie Webshops.

Die VLB-REST-API bietet die folgenden Funktionen.

Die VLB-REST-API baut auf die REST-Technologie (Representational State Transfer) auf und nutzt als Authentifizierungsmethode OAuth2. Jeder Datenbezieher erhält vom VLB Zugangsdaten, die je nach festgelegter Berechtigung einen Zugriff auf die freigeschalteten VLB-Daten ermöglichen.

Softwareanbieter können einen kostenfreien Zugang zur VLB-Webschnittstelle erhalten, um das VLB in die eigene Software einzubinden und so VLB-Kunden den Zugriff direkt aus der jeweiligen Software zu ermöglichen. Voraussetzung hierfür ist der Abschluss des VLB-API-Nutzungsvertrags.

Bitte beachten Sie:

  • Die VLB-REST-API dient zur Suche und zum Abruf der Produktinformationen einzelner Produkte. Für den Abruf größerer Datenmengen wie z.B. zur Befüllung einer kundeneigenen Artikeldatenbank empfehlen wir Ihnen unsere ONIX-Feeds.
  • Die Schnittstelle erlaubt nur lesende Zugriffe. Das Ändern oder Ergänzen von Produktdaten und Mediendateien ist über die VLB-REST-API nicht möglich. Wie Sie Inhalte an das VLB melden können, erfahren Sie im Bereich Datenanlieferung.

Produktsuche

Für die Produktrecherche stehen eine Schnellsuche zur Eingabe beliebiger Suchbegriffe (ISBN, Autor etc.) sowie eine boolesche Suche bereit. Die frei kombinierbaren booleschen Suchkriterien sind:

  • Suchkriterien:
    • Produktnummer,
    • Titel- und Untertitel,
    • Autor,
    • Verlag,
    • Schlagwort,
    • thema-Klassifikation,
    • Warengruppe,
    • Erscheinungsjahr,
    • Sprache,
    • Produktform,
    • Produkttyp,
    • Reihen und Hierarchien,
    • Zugangs- und letztes Änderungsdatum
  • Weitere Filtermöglichkeiten:
    • aktive und archivierte Titel,
    • Sortierung nach verschiedenen Kriterien

Beispielsweise kann eine Suche nach dem Verlag und dem Erscheinungsdatum kombiniert werden mit deren Hilfe sich z.B. eine Liste aller Titel des Ullstein-Verlages mit Erscheinungsjahr 2010 ermitteln lässt. Die Syntax der booleschen Suche entspricht der auf VLB-Online eingesetzten Suchsyntax.

Jede Suchanfrage liefert eine konfigurierbare Trefferliste im JSON Format. Das JSON-Format überzeugt durch seine Einfachheit und geringes Datenvolumen. Weitere Informationen zum Stellen einer Suchanfrage sowie Formatdetails für die Datenrückgabe entnehmen Sie bitte der VLB-REST-API Spezifikation.

Produktdetailabruf

Wenn Sie mehr zu einem Produkt Ihrer Trefferliste erfahren möchten, können Detailinformationen zu diesem abgerufen werden. Sämtliche Informationen zu einem Produkt können über eine API-Anfrage unter Angabe der GTIN-13 oder der VLB-ID (32-stellige vom VLB vergebene Identifikationsnummer) abgerufen werden.

Die Detailproduktdaten stehen in zwei Datenformaten zur Verfügung

  • ONIX
  • JSON
    • enthält alle in ONIX enthaltenen Produktinformationen sowie weitere durch das VLB angereicherte Angaben, wie Lieferbarkeitsinformationen verschiedener Auslieferer
    • im Vergleich zum ONIX-Format ist JSON leichtgewichtiger – Formatdetails entnehmen Sie bitte der API-Spezifikation

Mediendateiabruf

Die Ausgabe einer Liste im JSON Format der produktzugehörigen Mediendateienlinks ist über einen eigenen REST-API Aufruf möglich.

Für den Abruf und die Anzeige der Mediendateien sind die GTIN-13 (für Cover) bzw. die eindeutige Mediendatei-ID sowie die Berechtigung zur Anzeige der Mediendateien notwendig.

Bitte beachten Sie: Die Mediendaten-Funktion der REST-API ist primär für den Abruf der zum einzelnen Produkt gehörenden Mediendateien gedacht und nicht zum Abruf größerer Cover- bzw. Mediendateien-Mengen wie z.B. Aufbau eines Mediendatenpools. Hierfür empfehlen wir Ihnen unsere Mediendatei-Feeds.