Reminder - Digital Publishing Suite (DPS) will End of Life on August 31st, 2019.
Original publication date: 05/30/2013
Modified: 07/15/2013 (Change log)
Note: The Adobe® Content Viewer for Web SDK was revised in R27 (July 2013) to make the API similar to the native tablet viewer's API. If you deployed an embedded web viewer using the R26 (May 2013) API, your embedded web viewer will cease to work when R28 is released. Please update your API usage as described in this revised article. If you have questions about this article, use the tutorial feedback link at the bottom of the article. Please don’t contact technical support with questions about Adobe Developer Connection articles.
With the release of v26, DPS Professional Edition and Enterprise Edition customers can now display a library view of folios in a web page using a new store/library API. By using this API in conjunction with the new embedded web viewer (Adobe Content Viewer for Web SDK), publishers can create libraries for desktop browsers and display folio content in the embedded web viewer. For more information about the embedded web viewer go to Embedding Web Viewer Content in Your Web Page.
The embedded web viewer with a Custom Library is available to both DPS Professional and Enterprise subscribers, while enabling Custom Store features in the Web Viewer requires Direct Entitlement, a feature only available to Enterprise customers.
This API is similar to the native library/store API but does not provide a one to one mapping of features. For example, transactions are not used in this API but are in the native API. It is also not possible to buy or download folios with this API. To view folios you must use the embedded web viewer. If you would like more information about the native library/store API, check out the Getting Started article.
In this article you will learn how to use the API to display a list of folios and their metadata.
The sample files in this article output a list of folios with their metadata.
Figure 1: A list view of folios.
Using the API is a four step process.
- Create a new store instance,
adobeDPS.libraryService.createLibrary(<guid>, <optionsObject>, <successCallback>, <errorCallback>).
- Display the folios in your successCallback function.
To begin using the API you will need your account GUID. If you do not have it you can go here and enter your username and password to retrieve it. If you have not already done so, download the attached files and open index.html in any text editor. On line 32 change the value for guid to your guid. For testing you can use the file as is and view the folios using the supplied guid.
To view the sample files, open index.html in a browser. As you can see, this example is a very simple implementation of a library. Alternatively, the covers could be displayed in a grid, coverflow, one up view or anything else that can be done with HTML.
This article provided steps on how to display a list of your folios in a desktop browser. For information on displaying the folio content go to Embedding Web Viewer Content in Your Web Page.
July 15th: Updated article to reflect API change in R27 (July 2013).
Comments are currently closed as we migrate to a new commenting system. In the interim, please provide any feedback using our feedback form. Thank you for your patience.