The Bookmarks Service provides an API to manage user's bookmarks and playlists that works along with the Single Sign-On provided by PEACH. Bookmarks are saved within a playlist wich basically just an array of bookmarks. Playlists offer an
id, aname and a
system attributeto flag a playlist created by the system itself. In addition, Bookmarks available informations are and
id, a creation
date, and a
media_id referring the media linked to it. The service provides API endpoints to retrieve and update playlists and bookmarks.
|id||(int) The id of the playlist|
|name||(String) The name of the playlist|
|system||(Bool) If it is a base system playlist|
|id||(int) The id of the bookmark|
|date||(int) The creation date represented by the UNIX timestamp|
|media_id||(int) The media id it is saved for|
|Integration with Single Sign-On||The Bookmarks service requires the integration with an identity provider in order to authenticate the users.|
All API requests are authenticated by the Identity Provider. The integration is described in the integration documentation.
API documentation is available in a swagger UI [here][https://peach-test.ebu.io/bookmarksapi/doc] You have to be authenticated to test it. API support both oAuth token or session cookie. For convenient reason we suggest that you login using session cookie at [https://peach-test.ebu.io/idp/][https://peach-test.ebu.io/idp/] then your request to the API via swagger will be authenticate so you'll be able to test the whole API.
If you are interested in integrating or deploying a bookmarks service, it can be helpful to check small demonstration page which provides an example of frontend application using Bookmarks Service and Identity Provider.