eBookShelf
- Jasper Verfaillie
The eBookShelf stores every eBook the customer bought and allow him or her to download them.
Get eBookShelf
Get the eBooks list.
Link : https://wsmedia.tlsecure.com/api/json/00000/customer/ebookshelf
Request
HTTP Verb : GET
URL : http://{WS_URL}/api/{returnType}/{domainCode}/customer/ebookshelf
Parameters | Location | Type | Required | Default | Accepted |
|---|---|---|---|---|---|
token | Header | String(26) | v |
|
|
Response
Success
{
"response": {
"success": true
"code": 0
"message": "ebookshelf retrieved"
"object": {
"ebookshelf": {
"ebook": [1]
0: {
"ean": 9789025762186
"title": "Kaatje Kip"
"author": "Axel Scheffler & Bette Westera"
"purchaseDate": "2016-03-14 14:41:43"
}
}
}
}
}Error
{
"response": {
"success": false
"code": 10
"message": "ebookshelf empty"
}
}Codelist
Code | Success | Message |
|---|---|---|
0 | v | ebookshelf retrieved |
1 |
| domaincode malformed |
2 |
| connexion error |
3 |
| token empty |
4 |
| no token with that key |
5 |
| invalid token |
9 |
| {param} not {type} {(or undefined)} |
10 |
| ebookshelf empty |
99 |
| uncatched exception |
Get eBook link
Generate the link required to download the book.
While in test phase, we don't ask for links to the eBooks provider. So, you will receive this message:
“Test URL for EAN … & customer … & order …. Ask when you want that functionality to go live, generating real calls to the ePub provider.”
As soon as we'll turn this on, every link generated will be functional.
Example
https://wsmedia.tlsecure.com/api/json/00000/customer/ebookshelf/9789025762186
Request
HTTP Verb : POST
URL : http://{WS_URL}/api/{returnType}/{domainCode}/customer/ebookshelf/{ean}
Parameters | Location | Type | Required | Default | Accepted |
|---|---|---|---|---|---|
token | Header | String(26) | v |
|
|
ean | Path | String | v |
|
|
Response
Success
{
"response": {
"success": true
"code": 0
"message": "ebook retrieved"
"object": {
"ebook": {
"ean": 9789025762186
"title": "Kaatje Kip"
"author": "Axel Scheffler & Bette Westera"
"link": "[[http://{downloadlink}]]"
"purchaseDate": "2016-03-14 14:41:43"
}
}
}
}Error
Codelist
Code | Success | Message |
|---|---|---|
0 | v | ebook retrieved |
1 |
| domaincode malformed |
2 |
| connexion error |
3 |
| token is empty |
4 |
| no token with that key |
5 |
| invalid token |
9 |
| {param} is not {type} {(or undefined)} |
10 |
| ebook not exist |
99 |
| uncatched exception |