POST v4/activation_requests - Create

Use this API to send a one time activation link to a specific user for access to VitalSource Bookshelf. You can create multiple activation links for the same user/email/brand url combination, as long as a users access token is provided. The only validation is that the email address being provided is unique for a given user (access token) within the requesting institution/API key combination. If you have existing email templates, you can insert the activation link into your templates (set send_email to false). If not, VitalSource can send a plain-text email with an activation link to the user.

Note:

• Links are only good for a one-time use.
• If clicked a second time, user will be redirected to https://bookshelf.vitalsource.com/activation to request a new link/email.
• Links are good for 6 weeks.
• Verb/URI
• Data Definitions
  • Resend
• Request Headers
  • Request body - create example
  • Request example - resend
• Response
  • Response body - create example
  • Response body - resend example
  • Response descriptions
  • Sample default email
• Error Codes

Verb/URI

POST https://api.vitalsource.com/v4/activation_requests

Data Definitions

Resend

If you wish to resend/issue an existing activation request you can do so as follows.

Verb/URI

POST https://api.vitalsource.com/v4/activation_requests/:email/resend

Data Definitions

Request Headers

X-VitalSource-API-Key: ABCDEFGHIJKLMNOP
X-VitalSource-Access-Token: as787s7sd86s7ssrefg
Content-Type: application/json

Request body  - create example 

{
 "activation_request" : {
 "email": "{{vst_email}}",
 "brand_destination_url": "https://bookshelf.vitalsource.com",
 "send_email": false
 }
}

Request example - resend

https://api.vitalsource.com/v4/activation_requests/{{vst_email}}/resend

Response

Response body - create example

HTTP Code: 201 Created
{
 "id": "ALLCAPSNUMBERSALLCAPS",
 "email": “sri.krisha@univ.edu”,
 "send_email": true,
 "status": "Notification sent",
 "brand_destination_url": "https://bookshelf.vitalsource.com",
 "activation_url": "https://api.vitalsource.com/v4/activation_requests/ALLCAPSNUMBERSALLCAPS/activate",
 "expires_at": "Wed, 01 Jan 2019 19:28:13 +0000",
 "activated_at": null,
 "notification_sent_at": null
}

Response body - resend example

HTTP Code: 200 Ok
{
 "id": "ALLCAPSNUMBERSALLCAPS",
 "email": “sri.krisha@univ.edu”,
 "send_email": true,
 "status": "Notification sent",
 "brand_destination_url": "https://bookshelf.vitalsource.com",
 "activation_url": "https://api.vitalsource.com/v4/activation_requests/ALLCAPSNUMBERSALLCAPS/activate",
 "expires_at": "Wed, 01 Jan 2019 19:28:13 +0000",
 "activated_at": null,
 "notification_sent_at": null
}

Response Descriptions

Sample default email

TO: <send_email>
FROM: no-reply@vitalsource.com
Hi <first-name> <last-name>,
Thank you for your purchase!

In order to access your digital content, please click on the link below and follow the steps to set up your account. If you’ve already set up your account, you’ll go straight to your digital content library.

<activation_url>

*This link is good for one use and will expire after 6 weeks. For Support, please follow the Support link within your digital content library.

Error Codes