Book Resource documentation
1983433
Description
Represents a book in the system. Most are interal fields, name is the only safe field to change.
Action: create
POSTing to create a new book is unsupported for 3rd party developers, its use in this respect is not recommended.
Action: update
PUT https://getpapered.pixfizz.com/v1/books/:book_id
Update the information store on a book
Attributes
name | The given name to the book |
---|
Action: show
GET https://getpapered.pixfizz.com/v1/books/:book_id
Returns information and the status of the files being generated.
Poll this endpoint after the file has been requested to get updates.
Action: preview
GET https://getpapered.pixfizz.com/v1/books/:book_id/preview?code=:share
Returns an inline JPEG preview of the first page of the book.
For authenticated requests, a share code parameter is not needed.
For requests that aren't authenticated, supply the share code of the book that is being requested.
Attributes
share | The share code that is automatically generated for this book. Supplying this code bypasses our cookie-based authentication for the request. |
---|---|
width | Width of image returned, 300px maximum (100px by default), |
height | Height of image returned, constrained to width |
Current resource
Book#1983433
id | 1983433 |
---|---|
name | My Project |
share_code | jz70n2eu |
Links
self | /v1/books/1983433 |
---|---|
pages | /v1/books/1983433/pages |
files | /v1/books/1983433/files |