Postman Collection

VitalSource offers a Postman collection available here https://documenter.getpostman.com/view/151970/S1a63STF

Download the Postman app

The App has many features that make using our APIs easy. If you do not have the the Postman app please visit: https://www.getpostman.com/downloads/ to install on your device.

Getting started

The VitalSource public collection comes with all of our endpoints, standard workflows and an environment. All of our APIs require an API Key to successfully make a request. If you do not yet have one, please visit or contact your Integration and Onboarding manager to complete your set up. Replace the environment variable "vst_api_key" with your API key and use the workflow that most closely matches your use-case.

Region_capture_43.png

Some requests, when being made on behalf of a user, have other headers that need to be included. This is called an access-token. An example of that header (with the access token environment variable) is below:

Region_capture_44.png

Additionally some requests require explicit values to be passed within the request URL or request body. Here we have used environment variables as well. Anywhere you see that you'll need to replace with a real value and of course consult the API documentation to understand what they do and learn how to add payload from one endpoint into environment variables in Postman for use in the next call.

Region_capture_45.png

Coding Languages

The Postman app can produce sample requests in many supported languages. For more information on how to do this see the Postman doc here https://learning.getpostman.com/docs/postman/sending_api_requests/generate_code_snippets/

Was this article helpful?
1 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.