POST v3/credentials - Verify Credentials

Use this API to request updated user properties such as GUID, email, reference, and, most importantly, the user's access token to make subsequent requests on behalf of a user in the VitalSource Bookshelf ecosystem. This request can be made as either a single request or a bulk request by passing in multiple <credential> elements for each user.

VitalSource uses and enforces logical instance separation as one of many security measures to protect user accounts. Integrators can only access user accounts that were created or aliased by their own API keys.

For more information on users go to v3/users - Create

• Verb/URI
• Data Definitions
  • Submission Matrix
• Request Headers
  • Request body - reference user example
  • Request body - full user example (legacy customers only)
  • Request body - bulk example
• Response
  • Response body - reference user example
  • Response body - full user example (legacy customers only)
  • Response body - bulk example
  • Response descriptions
• Error Codes

Verb/URI

POST https://api.vitalsource.com/v3/credentials.xml

Data Definitions

Request can be done as a single request or in bulk by using multiple <credential> elements for each user.

Submission Matrix

Below is a mapping of which elements can be sent alone in order to request/verify credentials. This API will accept more than one credential(s) as part of a request.

Request Headers

X-VitalSource-API-Key: ABCDEFGHIJKLMNOP

Request body - reference user example

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<credentials>
 <credential access-token="{{variable_access_token}}" reference="{{variable_reference}}"/>
</credentials>

Request body - full user example (legacy customers only)

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<credentials>
 <credential password="{{variable_PW}}" access-token="{{variable_access_token}}"/>
</credentials>

Request body - bulk example

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<credentials>
 <credential reference="{{variable_reference}}"/>
 <credential access-token="{{variable_access_token2}}" reference="{{variable_reference2}}"/>
</credentials>

Response

Response body - reference user example

<?xml version="1.0" encoding="UTF-8"?>
<credentials>
 <credential email=“lettersandnumbers@placeholder.23332.edu" access-token=“numbersandlowercase” guid=“numbersandUPPERCASE” reference="yourReferenceID" email_verification_required="false" email_verification_completed="false">
 </credential>
</credentials>

Response body - full user example (legacy customers only)

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<credentials>
 <credential email="sri.krisha@univ.edu" access-token=“numbersandlowercase” guid=numbersandUPPERCASE” reference="" email_verification_required="false" email_verification_completed="false">
</credentials>

Response body - bulk example

<?xml version="1.0" encoding="UTF-8"?>
<credentials>
 <credential email=“lettersandnumbers@placeholder.23332.edu"access-token=“numbersandlowercase” guid=numbersandUPPERCASE” reference=“bulk-test-101" email_verification_required="false" email_verification_completed="false">
 </credential>
 <credential email=“lettersandnumbers@placeholder.23345.edu" access-token=“numbersandlowercase” guid=numbersandUPPERCASE”" reference=“bulk-test-102" email_verification_required="false" email_verification_completed="false">
 </credential>
</credentials> 

Response Descriptions

Error Codes