Revision

Introduction 

...

Image Added

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:

...

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.

...

{
  "EAN": "9999999999999",
  "ReadingMethod": "D",
  "Protection": "02",
  "RentalUnit": "DAG",
  "RentalNumberOfUnits": "21",
  "OrderReference": "123abc",
  "UserId": "XYZ"
}

{"Message": {
   "MessageType": "E",
   "MessageCode": "EBS-10003",
   "MessageText": "A product with this EAN is not available."
}}

*********************************
For testing the following data is available (other data will result in an error response):

...

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

...

{
  "EAN": "9789084999912",
   "UserId": "bookshelf@cb-logistics.nl",
  "UserPassword": "bookshelf"
}

...

{
    "Access": {
        "Accessable": "Y"
    }
}

...

{
  "EAN": "8711000287941",
   "UserId": "bookshelf@cb-logistics.nl",
  "UserPassword": "bookshelf"
}

...

{
    "Access": {
        "Accessable": "N"
    }
}

...

{
  "EAN": "9789084999912",
  "UserId": "Tester@cb-logistics.nl",
  "UserPassword": "bookshelf"
}

...

{
    "Message": {
        "MessageType": "I",
        "MessageCode": "EBS-10038",
        "MessageText": "Vitalsource user account unknown."
    },
    "Access": {
        "Accessable": "N"
    }
}