This API verifies the existence of a VitalSource Bookshelf account. You can use the user's email, GUID or reference to locate the account information or details. Pass a single element in the header as a parameter.
Verb/URI
https://api.vitalsource.com/v3/users.xml/{param}Data Definitions
Name
|
Usage
|
Description
|
Data Type
|
Example
|
Required
|
---|---|---|---|---|---|
URL param | The default request | v3/users.xml/{guid} | Yes | ||
email address | URL param | Email address is only valid in the case of full users where your API key is the grantor of rights. | Regex email | v3/users.xml/{email} | No |
reference | URL param | Reference strings are passed during Create and can be modified via Update | string | v3/users.xml/{reference} | No |
guid | URL param | Global User ID (guid) is always returned in the payload after a successful create user. | string | v3/users.xml/{guid} | No |
?full=true | URL param | Returns additional elements in response including security questionid/response, promotion, and survey options | string | v3/users.xml/{{guid}}?full=true | No |
Request Headers
X-VitalSource-API-Key: ALLCAPSANDNUMBERS
Response
Response Body
HTTP Code: 200
<?xml version="1.0" encoding="UTF-8"?> <user> <email>bob@placeholder.23332.edu</email> <first-name>Bob</first-name> <last-name>Bobbington</last-name> <guid>YDAASDFGHJKLNRHPJ3Q6</guid>
<uber-license>false</uber-license> <reference>bob01_4567</reference> <sso-only>true</sso-only> <require-deactivate>false</require-deactivate> <require-book-list-update>false</require-book-list-update> <store-url>http://someurl.somestore.com</store-url> <timestamp>20150311153046</timestamp> <max-desktop-activations>2</max-desktop-activations> <max-mobile-activations>2</max-mobile-activations> <email-locked>false</email-locked> </user>
Response Descriptions
Name
|
Description
|
---|---|
Email address of the user. This is NOT for a reference user account, only for accounts with UN, PW combinations. | |
first-name | User's first name |
last-name | User's last name |
access-token | Used for subsequent calls related to this specific user. This may expire; see reset token |
guid | Global User ID, produced at create by VitalSource and returned in payload |
sso-only | True or false value; set to true if a reference-only account was created. Once a user configures his Bookshelf account with an email/password or if the account was created using email/password this will be false. |
FYI; if you need an access token for a user go to the Credentials endpoint
Error Codes
HTTP & Error messages
|
Message
|
Notes
|
---|---|---|
200 |
|
Success |
403 |
403 - Forbidden |
Verify API key |
404 |
404 - Not Found |
Verify params |
Comments
Please sign in to leave a comment.