A product license grants the user the right to access a product until the license expiration date. This service provides a listing of all products and their expirations or checks a particular product's licensing status for a specific user to ensure he has access to the license and book before displaying or providing a single sign-on (SSO) experience to the user.
Supported Roles and Authentication Protocols
|Authentication Protocols||API Key, Access Token|
|Valid for Roles||System to System|
There are two ways to view license details: all licenses for a specific user based on access token which will return an array of data, or the license details for a specific title using the sku (optional) and license_type (optional).
|license_type||online, downloadable, all||No|
X-VitalSource-API-Key: ABCDEFGHIJKLMNOP X-VitalSource-Access-Token: as787s7sd86s7ssrefg
Depending on your request, a single item or multiple items will be returned, separated by <license/> elements.
HTTP Code: 200
<?xml version="1.0" encoding="UTF-8"?> <licenses> <summary distributable_products="1" total_products="1"/> <license publisher="McGraw-Hill Higher Education" imprint="McGraw-Hill Higher Education" type="online" sku="9780072965476" expiration="Thu, 10 Mar 2016 22:14:54 GMT" code-use="code-api" part_of="" name="American Government 2008 Edition" term="" kind="book"/> </licenses>
|summary||distributable_products||Number of licensed products returned in the initial request to which the user has access|
|total_products||Total number of licenses to products for a user, including deactivated titles|
|license||publisher||Publisher for product|
|imprint||Imprint for product|
|type||License type, either online or downloadable. If there is both a downloadable and an online license type for the same product, two <license/> elements will be returned (one for each type).|
|sku||Unique product identifier, also known as the VBID|
|expiration||Date the license expires; if one is not set, this will return "never"|
|code-use||How the code was created and meant to be redeemed. code-api, add-drop, promotional, and p+e are valid returns.|
|kind||Describes the "kind" of asset|
HTTP Code: 200
<?xml version="1.0" encoding="UTF-8"?> <error-response> <error-code>474</error-code> <error-text>User could not be found</error-text> </error-response>