This API returns VitalBook asset information for a given VBID.
Verb/URI
https://services.vitalbook.com/vital_books/{{VBID}}.xmlData Definitions
The minimum fields needed to request a VBID
Name
|
Usage
|
Description
|
Data Type
|
Example & Details
|
Required
|
---|---|---|---|---|---|
api_key | Query param |
your VitalSource API key |
string | ALLCAPSANDNUMBERS | Yes |
Request Headers
Request header - default example (using cURL)
curl -X GET \
'https://services.vitalbook.com/vital_books/L-999-70049.xml?api_key=YOUR_API_KEY_HERE' \
-H 'Accept: */*' \
-H 'Accept-Type: application/xml' \
-H 'Host: services.vitalbook.com' \
Response
Response body - default
<?xml version="1.0" encoding="UTF-8"?>
<vital_book vbid="L-999-70049">
<build_status>approved</build_status>
<title>Great Expectations</title>
<price/>
<store_price/>
<digital_list_price/>
<edition>0</edition>
<imprint_id>100</imprint_id>
<vbk_format>epub</vbk_format>
<fpid/>
<faculty_review_only>0</faculty_review_only>
<fulfillment_only>0</fulfillment_only>
</vital_book>
Response Descriptions
Name
|
Description
|
---|---|
build_status | Response from the VitalSource build system |
title | Title sent with asset |
price | Price sent with asset, if applicable |
store_price | VitalSource store price of asset, if applicable |
digital_list_price | DLP sent with asset, if applicable |
edition | current edition of asset |
vbk_format | digital format of asset. (Note: page_fidelity is the official name for PDF) |
Error Codes
HTTP & Error messages
|
Message
|
Notes
|
---|---|---|
200 |
Success |
The build process was successful and the book is ready. |
403 |
The api_key is incorrect or does not have the proper permissions to access this service |
|
404 |
User was not found |
|
500 |
Error creating the VitalBook |
Verify required fields |
500 |
Could not process the source file |
VitalSource was able to download the source file, but we were unable to process the file. This may be caused by formatting issues with the PDF/EPUB or file corruption. |
500 |
Could not retrieve the source file |
VitalSource was not able to download the source file from the given url. |
Comments
Please sign in to leave a comment.