This is the home for API code examples for Vivantio. We currently have two main Visual Studio solutions:
VivantioApiWeb.sln- an ASP.NET Core 9 MVC full demo application (see the live application here).VivantioApiConsole.sln- a .NET 9 Console Application that demonstrates using the Entity (Custom Form) and Ticket APIs. Requireds the codebase to be updated with 'seed Id' values.VivantioApiInteractive.sln- a .NET 9 Console Application that demonstrates using a wider range of APIs in a more interactive fashion that avoids having to alter the codebase with 'seed Id values'.
All our API examples are published under the MIT Public License; see License.txt for further information.
You can download the examples as a zip file, or clone the Git repo - whatever works best for you.
Before you can run the examples, you'll need to create credentials as User environment variables. The settings you need are available from the Vivantio Admin Area under Admin > Integration & API > Downloads. One way of setting User environment variables would be to use this PowerShell script with the appropriate values:
[System.Environment]::SetEnvironmentVariable("VIVANTIO_PLATFORM_URL", "<platform url starting with https:// and ending with a trailing />", "User")
[System.Environment]::SetEnvironmentVariable("VIVANTIO_USERNAME", "<username>", "User")
[System.Environment]::SetEnvironmentVariable("VIVANTIO_PASSWORD", "<password>", "User")Once those values are set you should be able to "Run" the examples from within Visual Studio! (Note you may need to restart Visual Studio for the environment variables to be recognised.)
- See our Tutorials repo that explains how to test our APIs with Postman.
- See our API Reference pages for a catalogue of supported APIs.