| Table of Contents |
|---|
Revision
| Version | Date | Description |
|---|---|---|
| As of May 17, 2021, CB will no longer support TLS 1.0 and 1.1 | |
| Initial document |
Introduction
...
This web service is intended to support the order process of customers of CB for the temporary availability (renting) of digital products.
...
Path: /rest/api/v1/DigitalProductRentalService
Specific messages (type/code/text) for this webservice
...
Type | Code | Text |
E | EBS-00001 | Something went wrong in processing the order. Your order is not fulfilled. |
E | EBS-10003 | A product with this EAN is not available. |
E | EBS-10004 | This product is not available for delivery. |
E | EBS-10005 | This OrderReference has already been used, use another reference. |
E | EBS-10006 | This product can not be ordered yet. |
E | EBS-10017 | Your credit limit has been exceeded. |
E | EBS-10034 | This product is not available for the given reading method. |
E | EBS-10043 | The combination of ReadingMethods and Protection is not allowed |
E | EBS-10045 | No valid license model found for this order |
E | EBS-10046 | For licensing models Shoulder and Tail, the rental period has to be 3 weeks |
E | EBS-10053 | Referenced order not found |
E | EBS-10054 | Referenced order is not for the same UserId |
E | EBS-10060 | Product ordered but no price available yet, please try again tomorrow. |
Test environment
For information about the test environment and the available test titles see:
...
| title | Click here for digital products for testing purposes |
|---|
...
| E | EBS-10063 | The field EAN is mandatory |
E | EBS-10064 | The field ReadingMethod is mandatory |
E | EBS-10065 | The field Protection is mandatory |
E | EBS-10066 | The field RentalUnit is mandator |
E | EBS-10067 | The field RentalNumberOfUnits is mandator |
E | EBS-10068 | The field OrderReference is mandatory |
E | EBS-10069 | The field UserId is mandatory |
E | EBS-10070 | Invalid value for ReadingMethod |
E | EBS-10071 | Invalid value for Protection |
E | EBS-10072 | Invalid value for RentalUnit |
E | EBS-10073 | The field EAN must be 13 long |
E | EBS-10074 | The field RentalNumberOfUnits must be numeric (1-99999) |
E | EBS-10075 | The field OrderReference must be maximum 100 long |
Operation: placeOrder
This operation is used to place orders with the purpose of renting out digital products to subscribers. The customer places an order for a title the subscriber would like to rent. The operation returns an url to where the digital product is available.
Request
Parameter | Description | Optionality | Allowed values |
EAN | The EAN for which the order is placed | Mandatory | 13 positions |
ReadingMethod | The method the subscriber uses to read the digital product (Download or On-line reading in the Cloud). | Mandatory | D (Download) |
Protection | The security that needs to be included in the delivery of the digital order product. | Mandatory | 00 (no protection)
|
RentalUnit | The rental unit | Mandatory | DAG |
RentalNumberOfUnits | The number of rental units | Mandatory | max 21 |
OrderReference | This is the internal reference of the customer to identify the order. This reference needs to be customer-unique. | Mandatory | max. 100 positions |
UserId | The identification of the end user. Is used to authenticate the end user (subscriber of the customer) upon delivery of the digital product. | Mandatory | Also used to validate the addition. The addition must be for the same user |
CbOrderReference | The unique value of the CbOrderReference of a previously executed order to deliver digital products. | Optional | Also used to check whether an addition may be made to a previously executed order. |
Response
...
Parameter | Description | Optionality | Allowed values |
CbOrderReference | Unique CB internal reference to identify the customer order. | Mandatory | |
EAN | The EAN from which the digital product is delivered. | Mandatory | 13 positions |
URL | URL of the address where the digital product is available for delivery. Involves a URL to download a digital product. | Mandatory |
Examples
Situation | Available product | ||||||||||||||||
| |||||||||||||||||
| |||||||||||||||||
Operation: checkAccess
This operation gives as answer if the supplied Bookshelf/VitalSource user has access to the supplied product (purchased on Bookshelf/VitalSource).
It can be used for example on a publisher website for checking if the user should be granted access to specific digital content that is only available for users who purchased the related product.
Request
- EAN : The EAN of the product/title that has to be checked (required)
- UserId : Identifier of the Bookshelf/VitalSource user (required)
- UserPassword : Password of the Bookshelf/VitalSource user (required)
Response
- Accessable : Indication (Y/N) if the user has access tot he specified product.
Examples
Situation | Unavailable product | Request
*********************************
For testing the following data is available (other data will result in an error response):
...
| ||||||||
| ||
| ||
| ||
| ||
| ||
| ||
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"Access": {
"Accessable": "Y"
}
} |
| language | yml |
|---|---|
| title | Request |
| ||
| ||
| ||
| ||
| ||
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"Access": {
"Accessable": "N"
}
} |
| language | yml |
|---|---|
| title | Request |
| ||
| ||||||||
| ||||||||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|