This is the home for API tutorials for Vivantio Pro / ITSM. We'll be expanding these tutorials over time so please do let us know what you would like to see here.
Postman is a popular tool for working with APIs, and caters for those who are consumers of APIs as well as those creating them. Consumers of APIs can call an API from Postman and get to understand how it works in terms of inputs, authorization and so on.
One of the useful things you can do with Postman is create collections of API calls that can be exported for others to import and use. This is what we're doing with the Vivantio Pro / ITSM APIs, along with documentation to help you understand how to use the collections.
If you are new to Postman these resources will help you get up to speed:
You can download the Postman application from here and once installed you will need to create an account and be logged in.
The general detail of everything you need to configure is covered in the New to Postman? video series we've linked to above. Specifically you will need to:
- Download or clone this repo to your local machine.
- In Vivantio Pro or ITSM navigate to Admin > Integrations & API > Downloads so you have access to your API Credentials.
- Create a new Postman environment called (for example) Vivantio.
- In the Postman Vivantio environment create three variables and populate INITIAL VALUE and CURRENT VALUE with values from API Credentials:
base_url= Platform Url plus/api/username= Usernamepassword= Password
- Navigate to File > Import and choose the collection file from our repo that you would like to import.
Please see the following pages for guidance on using specific API collections:
- See our Samples repo for sample applications that use APIs.
- See our API Reference pages for a catalogue of supported APIs.
- See our API Wiki for basic details on how to use the APIs.