Introduction
This page describes the changes between the public API of the DDB version 1 and version 2.
Version 1 is available at https://api.deutsche-digitabledigitale-bibliothekebibliothek.de
Version 2 is available at https://api.deutsche-digitabledigitale-bibliothekebibliothek.de/2
The data behind the two versions is identical.
Resources
The documentation of the API version 1 can be found https://labs.deutsche-digitale-bibliothek.de/app/ddbapi/
...
An OpenAPI YAML of version 2 is available at https://api.deutsche-digitale-bibliothek.de/2/q/openapi
Changes
No more API key
In order to use version 1 you might need an API key. As developing new applications using version 1 is dicouraged, new API keys are not issued. Using version 2 all endpoints are usable without an API key.
New Login
There are some new features in version 2 of the API that require a login, e.g. this includes saving favourites and searches. Therefore there are new API endpoints to create and manage user accounts under /user. A detailed description of these endpoints can be found here at User API
Search Queries
The Search API has been reduced to include on only the generic search endpoint. The The other endpoints of the Search API were tailored to speciffic specific functionalities of the DDB frontend are and were no longer needed. The Search API endpoint now also supports POST requests in addition to the previously supported GET requests so allow longer queries.
Items Queries
The endpoints under /items are about the same as in version 1. There are very minor changes to the AIP model used, mainly due to the fact that other XML libraries are used internally. The only two substancial changes regarding the content is the fact that the object source is no longer inlined into the AIP and that the new API supports accessing the english and the french translations of the AIP model where available.
All items endpoints except for the /source/record resources now support XML as well as JSON responses.
A new endpoint provides a citation file in bib format for newspaper items.
All details regarding the items endpoints can be found at Item API
Saved searches and Favourites
Version 2 of the public DDB API offers the possibility to save favourite objects aka. bookmarks for logged in users and allows organizing these bookmarks in folders. Details on the endpoints to manage Bookmarks can be found here: Favourite API
Furthermore, starting from Backend 7.3 it is also possible to save search queries for logged in users, details on this can be founf found at Saved Searches API