Shop Manual 3.1.4 Issued: 2018-03-27, Axiell Media AB, [email protected]
Total Page:16
File Type:pdf, Size:1020Kb
Shop manual 3.1.4 Issued: 2018-03-27, Axiell Media AB, [email protected] This document describes how to create an integrated shop using Axiell Media’s platform. Part of the text is technical and is intended for the persons performing the system integration work. We have made every effort to avoid errors in this manual. Faults or omissions are unintentional and we appreciate if you let us know if you find any. This manual is also available at https://webservices.elib.se/shop/ The manual is not to be redistributed and is only intended for the specific use of integrating with Axiell Media, all other uses are reserved by Axiell Media. Shop manual 3.1.3 © Axiell Media AB. page 1 Contents Shop manual 3.1.4 ................................................................................................................................... 1 Revision history ................................................................................................................................... 5 Changes to the Shop API ................................................................................................................. 5 Introduction ......................................................................................................................................... 6 Background ...................................................................................................................................... 6 Using this manual ............................................................................................................................ 6 Information from Axiell Media ........................................................................................................ 7 Resources ........................................................................................................................................ 7 Integration process .............................................................................................................................. 8 Before you begin the API integration .............................................................................................. 8 Overview – work flow ...................................................................................................................... 8 Importing product information ....................................................................................................... 8 Interpret the product information .................................................................................................. 8 Completing an order........................................................................................................................ 9 Deliver using a digital book shelf (download area) ......................................................................... 9 Streaming ........................................................................................................................................ 9 Digital watermarking ....................................................................................................................... 9 Orders for test purposes ............................................................................................................... 10 Launch of the service ..................................................................................................................... 10 Audio book formats ........................................................................................................................... 11 Audio book samples ...................................................................................................................... 11 Ebook formats ................................................................................................................................... 12 Ebook samples ............................................................................................................................... 13 Web services ..................................................................................................................................... 13 API consisting of web services ....................................................................................................... 13 List of web service operations ........................................................................................................... 15 Web services used to deliver books .............................................................................................. 15 Web services used for administration ........................................................................................... 19 Appendix A - Streaming ......................................................................................................................... 20 Flash streaming ................................................................................................................................. 20 The Flash player ............................................................................................................................. 20 An example of the XML response .................................................................................................. 20 Http Streaming .................................................................................................................................. 22 Shop manual 3.1.3 © Axiell Media AB. page 2 Http Streaming .............................................................................................................................. 22 Building an smart phone application............................................................................................. 22 Work flow ...................................................................................................................................... 22 Encrypted stream .......................................................................................................................... 22 Android streaming module ........................................................................................................... 24 GetStreamingSettings .................................................................................................................... 24 SetStreamingSettings .................................................................................................................... 24 GetBookmarks ............................................................................................................................... 26 CreateBookmarks .......................................................................................................................... 26 Appendix B – Example of book information .......................................................................................... 27 Appendix C – Export types .................................................................................................................... 31 Identifiers .......................................................................................................................................... 31 Book types ......................................................................................................................................... 31 Languages .......................................................................................................................................... 31 Date/DateTime .................................................................................................................................. 31 Formats .............................................................................................................................................. 31 Distribution region ............................................................................................................................ 31 Book price ...................................................................................................................................... 33 Promotions – promotional pricing ................................................................................................ 33 Book list ......................................................................................................................................... 34 Book availability status and lifecycle ............................................................................................. 35 Relations – related products ............................................................................................................. 36 Book length ....................................................................................................................................... 36 Contributor types .............................................................................................................................. 37 Categories .......................................................................................................................................... 37 Supplements ...................................................................................................................................... 37 Chapter information .......................................................................................................................... 38 Error codes ........................................................................................................................................ 38 Appendix D - Watermarks ....................................................................................................................