When and How to Use the Vivantio API
WHEN SHOULD I USE THE VIVANTIO API?
We’d encourage the use of Webhooks and Web Methods wherever possible for a number of reasons such as:
- You don’t need to write any code.
- They’re hosted within Vivantio so don’t need to be deployed separately.
But there are a number of situations where the API is the better or only choice. Let’s explain with two most common instances: Integrating with Legacy Systems and Developing Custom Applications.
INTEGRATING WITH LEGACY SYSTEMS
In this case, you’ll be integrating Vivantio with another system that:
- Doesn’t have an HTTP API (or doesn’t support HTTP Basic Authentication)
- Isn’t externally accessible
- Doesn’t support Webhooks to send data to other applications
With this situation, you’ll need to write custom middleware to push data to and pull data from the external system. Our API can help with that.
(It’s worth noting that you might find Webhooks and Web Methods are still useful in this scenario. Webhooks are still the only way to have Vivantio automatically push data out in response to another event. Web Methods can also simplify the code you have to write on your side to interact with Vivantio.)
DEVELOPING CUSTOM APPLICATIONS
In this case, you might be developing your own software and need Vivantio to communicate with it.
For example, Vivantio includes a comprehensive and flexible Self Service Portal, but maybe it doesn’t quite work for you. If you need features available that aren’t supported in the standard SSP, you might want to create your own.
In this kind of scenario or ones similar to it, utilizing our API could be more appropriate.
HOW DO I USE THE VIVANTIO API?
There are two key resources available to help you get started: Code Samples and Documentation and the API Reference.
CODE SAMPLES AND DOCUMENTATION
The best place to start is the API Samples repo on our GitHub page. Here you’ll find:
- Documentation on the core concepts of the API such as API Design, Authentication and Querying
- Code samples (Note: currently only in .Net, but we’re working on other languages.)
You can also jump straight to our live samples to see sample applications running.
Once you’ve got the basics down and are comfortable working with the API, you can find a complete list of available endpoints and methods in the API Reference.
WHAT CAN YOU DO WITH THE VIVANTIO API?
Quite a lot! Vivantio was developed API-first, so the majority of the functions available within Vivantio are available via the API.
We should note that administrative features are not available in the API and only available in the main GUI.