Page tree
Skip to end of metadata
Go to start of metadata

Revision

DateDescription

 

As of May 17, 2021, CB will no longer support TLS 1.0 and 1.1

 

Initial document

Introduction

This webservice is meant for supporting the process of the publisher regarding (delivering) digital content.

It has the following operations: 

  • checkAccess

Path: /rest/api/v1/DigitalProductPublisherService

Specific messages (type/code/text) for this webservice:

typeCodeText
IEBS-10038Vitalsource user account unknown

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

Situationvalid Bookshelf/VitalSource user and inaccessible product
Request
{
  "EAN": "9789084999912",
   "UserId": "bookshelf@cb-logistics.nl",
  "UserPassword": "bookshelf"
}
Response
{
    "Access": {
        "Accessable": "Y"
    }
}
Situationunknown Bookshelf/VitalSource user

Request
{
  "EAN": "8711000287941",
   "UserId": "bookshelf@cb-logistics.nl",
  "UserPassword": "bookshelf"
}
Response
{
    "Access": {
        "Accessable": "N"
    }
}
Situationunknown Bookshelf/VitalSource user
Request
{
  "EAN": "9789084999912",
  "UserId": "Tester@cb-logistics.nl",
  "UserPassword": "bookshelf"
}
Response
{
    "Message": {
        "MessageType": "I",
        "MessageCode": "EBS-10038",
        "MessageText": "Vitalsource user account unknown."
    },
    "Access": {
        "Accessable": "N"
    }
}


General webservice information

Content-Type

The content/body in the request and the response has to be / will be in json format.

Content-Typeapplication/json

Supported SSL/TLS protocols 

TLS Protocols

TLS1.0 
As of May 17, 2021, CB will no longer support TLS 1.0 and 1.1
TLS1.1
TLS1.2
TLS1.3 will be supported in Q2 2021

will be supported in Q2 2021

Authentication

CB uses message level authentication based on header parameters “UserName” and “Password”. These will be provided when you sign up for this service at CB.

Response messages

If a webservice is technical able to process, it will respond 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/information about the answer (MessageType “I”).

A message contains of:

A message contains of:
MessageTypeE or I
MessageCodeformat XXX-99999
MessageTextTextual information/reason

The following generic error (E) messages are defined:

WMS-00002Invalid username/password combination
WMS-00004Not authorized to use this service
WMS-00005No username and/or password provided by the caller
WMS-00008The request does not comply with the yaml definition
EBS-11000Something went wrong in processing the request
EBS-11001Something went wrong in processing the request

Optional parameter

For optional attribute this applies:

  • be filled with the correct value
  • be left out
  • be filled with “” (read empty)


An optional parameter may therefore never be filled with the value null.

Volume limits and performance requirements

Volume

Webservice calls are limited to a maximum of 5 web service calls per account at the same time.

Performance

Availability: 99% measured over the last 12 months,  excluding planned maintenance.
The response time is a maximum of 2000 ms in 95% of the cases, measured as an average over 10 minutes.

Test environment


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

Invalid Vitalsource account credentials (UserId/UserPassword)Tester@cb-logistics.nl / bookshelf
Valid Vitalsource account credentials (UserId/UserPassword)bookshelf@cb-logistics.nl / bookshelf
Accessible EAN9789084999912
Inaccessible EAN8711000287941
  • No labels