Revision
Date | Description |
|---|---|
to be announced | New version due to move to a new server. URL change and yaml version. SOAP is deprecated |
8 aug. 2022 | Delivery Channel BS (Bookshelf) is deprecated |
22 feb. 2022 | As of July 1, 2022, CB will no longer support Bookshelf |
3 mei 2021 | Specific messages (type/code/text) for this webservice: Some of EBS-* error code will change to WMS-* codes |
29 apr. 2021 | As of May 17, 2021, CB will no longer support TLS 1.0 and 1.1 |
8 apr. 2021 | Initial document |
Information
This webservice supports the order process for customers buying digital products. The service has the following operations:
Operation: checkOrderable
Web shops display the range they want to sell in their shop window to their customers. Once the customer wants to checkout the products in the shopping cart, the online shop needs assurance that the item is available and orderable. This moment ideally comes just before payment. If the desired item cannot be ordered/delivered and the customer has already paid, the webshop has extra work to correct the payment and the customer will have a negative experience with the webshop. This method is used to ensure that an e-book can be ordered/delivered. The answer indicates a Yes or No (Y or N).
Request | |||
Parameter | Description | Optionality | Allowed values |
EAN | The EAN of which availability and deliverability needs to be checked | Mandatory | 13 positions |
DeliveryChannel | The method the subscriber uses to read the digital product | Optional | CBW (CB registered web shop) |
Response | |||
Parameter | Description | Optionality | Allowed values |
Orderable | Indicates orderability of the requested digital product through the desired channel | Mandatory | Y (Yes = Orderable) |
Operation: placeOrder
Web shops want to deliver digital products to a customer. The web shop therefore needs to place an order with CB for the required article. CB will give feedback as to where the digital product is available.
Request | |||
Parameter | Description | Optionality | Allowed values |
EAN | The EAN which is ordered | Mandatory | 13 positions |
DeliveryChannel | The method the subscriber uses to read the digital product | Optional | CBW (CB registered web shop) |
OrderReference | This is an internal reference used by the CB-customer to identify the order. This identifier needs to be unique | Mandatory | Max. 100 positions |
Response | |||
Parameter | Description | Optionality | Allowed values |
CbOrderReference | Unique CB internal reference to identify the customer’s order | Mandatory | |
EAN | The EAN of which the digital product is to be delivered | Mandatory | 13 positions |
URL | URL of the address where the digital product is available for delivery. this is an URL to download the digital product | Optional | |
Operation: getContentUrl
This operation offers the CB-customer the possibility to retrieve the link to the content based on an existing order.
Request | |||
Parameter | Description | Optionality | Allowed values |
OrderReference | This is an internal reference used by the CB-customer to identify the order. This identifier needs to be unique. | Mandatory | Max. 100 positions |
Response | |||
Parameter | Description | Optionality | Allowed values |
CbOrderReference | Unique CB Internal reference to identify the customer’s order | Mandatory | |
EAN | The EAN of which the digital product is to be delivered | Mandatory | 13 positions |
URL | URL of the address where the digital product is available for delivery. This is an URL to download digital product | Mandatory | |
Authentication & Authorisation
Authentication | Username |
Authorisation | Password |
Webservice information
Webservice approache | REST - Representational State Transfer |
Definition |
|
Content type | The content/body in the request and response has to be, will be in json format |
‘Optional’ parameter | For any optional attribute one of the following options applies:
An optional parameter may therefore never be filled with the value null |
URL Test | |
URL Production | |
Supported SSL/TLS protocols | TLS 1.2 |
TLS 1.3 |
Response messages
If a webservice is technical able to proces, it will respons with a HTTP status 200. the response can contain a message with additional information. It can be an error (MessageType”E”) in case it wasn’t possible to supply a functional answer or additional explanation/informatie about the answer (MessageType “T”).
HTTP code | Code | |
|---|---|---|
200 | ||
200 | EBS-10003 | A product with this EAN is not available |
200 | EBS-10004 | This product is not available for delivery |
200 | EBS-10005 | This OrderReference has already been used, use another reference |
200 | EBS-10006 | This product may not be ordered |
200 | EBS-10009 | This product may not be ordered |
200 | EBS-10017 | Your credit limit has been exceeded |
200 | EBS-10077 | No Order found with this OrderReference |
400 | CEP-200 | An generic error code for syntactic errors. |
400 | CEP-002 | <detail "invalid (based on swagger-definition) input" message> |
401 | CEP-003 | You are not authenticated |
404 | CEP-004 | Resource not available |
500 | EBS-11000 | Something went wrong in processing the request. (<error-reference-code>) |
500 | "Internal server error" |
Volume limits and performance requirements
Volume
Web service calls are limited to a maximum of 5 web service calls per account at the same time
Performance
The response time is a maximum of 2000 ms in 95% of the cases, measured as an average over 10 minutes.
Availability
The general availability of the service equals an average of 99.95% in prime time (08:00 - 01:00) in the standard time zone: UTC GMT +1.
Outside this window, the web service availability may be lower, but never less than 95%. Planned maintenance by CB will be executed outside prime time and will be announced at least five working days in advance.
Exception: CB can start planned maintenance four times a year at 23:00 hours.
Planned downtime: 10 hours per year
Unplanned downtime: 10 hours per year
Digital Product for test purposes
Product form | Technical Protection | EAN | Author*Title | Remark | Content title |
|---|---|---|---|---|---|
EPUB(2)
| Geen DRM (00)
| 9789084999936 | *VROUWENKIESRECHT | Text only | Zoenen met rommel |
9789078124832 | VINK*DOOD VAN DANTES KEIZER | > 1000 characters +images | Chief Thunderstruck and the big bad bear | ||
9789491259128 | VINK*WREKER VAN FLORIS V | > 1000 characters +images | The Lost history of 1914 | ||
9789491259272 | VIS*BRAINS | Text only | Filosofie van de bewegingswetenschappen | ||
EPUB(2) | Watermerk (02) | 9789084999820 | *TESTEBOEK EPUB MET WATERMERK | Text only | Filosofie van de bewegingswetenschappen |
9789023443032 | BOOGAARD*VERTICALE STRAND | Text only | Filosofie van de bewegingswetenschappen | ||
9789023473312 | BROUWERS*CASINO | < 1000 characters +images | Foto zegt meer dan 1000 woorden | ||
9789023443315 | CAMPERT*LIEFDE IN PARIJS | < 1000 characters +images | Foto zegt meer dan 1000 woorden | ||
9789084999974 | GRUNBERG*EPUB2 MET VOETNOTEN EN VERWIJZINGEN | Epub2 with footnotes and references | The gradual acceptance of the Copernican theory of the universe | ||
9789084999981 | GRUNBERG*EPUB2 MET TABELLEN | Epub2 with tables | Lectures on Stellar Statistics | ||
EPUB(3)
| Watermerk (02)
| 9789084999851 | GRUNBERG*EPUB3 AUDIO EN VIDEO | Audio and video + text | EPUBTEST 0120 - Media Overlays Reflowable Tests |
9789084999868 | GRUNBERG*EPUB3 FIXED LAYOUT | Fixed layout | EPUBTEST 0201 - FXL Support Tests | ||
9789084999875 | GRUNBERG*EPUB3 FIXED LAYOUT SPREAD | Fixed layout spread | EPUBTEST 0202 - FXL Spreads (both) Tests | ||
9789084999882 | GRUNBERG*EPUB3 REFLOWABLE CONTENT | Reflowable content | EPUBTEST 0202 - FXL Spreads (both) Tests | ||
9789084999905 | GRUNBERG*EPUB3 MATHML EN SVG | MathML en SVG | A First Course in Linear Algebra | ||
Geen DRM (00) | 9789084999813 | *TESTEBOEK PDF MET WATERMERK DRM | < 1000 characters +images | Het Achterhuis | |
Watermerk (02) | 9789084999813 | *TESTEBOEK PDF MET WATERMERK DRM | < 1000 characters +images | Het Achterhuis | |
|
| 9789023465126 | CAMPERT*SOMBERMAN'S ACTIE | < 1000 characters +images | PDF ebook voor test doeleinden |
|
| 9789023449713 | CLAUS*JAAR VAN DE KREEFT | 141 MB | "De gorgel in arabisch oid" |
|
| 9789023443100 | CAMPERT*VURRUKKULLUK | 141 MB | "De gorgel in arabisch oid" |
|
| 9789084999929 | GRUNBERG*PDF MET VOETNOTEN EN VERWIJZINGEN | PDF with footnotes and references | Project Gutenberg’s The Mathematical Analysis of Logic |