Introducing VIKTOR's API: endless possibilities

Why we developed the API

We improved our API and made it public to give you more flexibility and power to automate your workflows! We already saw some impressive applications during the beta testing phase and are excited about the potential it unlocks. We look forward to seeing the innovative ways you will use it.

The API is also a fundamental building block in our vision: a world that utilizes its engineering knowledge in a better and more scalable way. It lays the groundwork for many exciting developments that will come soon. So, stay tuned 😉

A world of endless possibilities

The API allows you to access and utilize the data and logic stored within the VIKTOR platform and your apps. The possibilities are vast. Here are just a few examples of what the community has done to illustrate its potential:

Connect VIKTOR apps

Let's think for a moment that you have design, structural, and geotechnical engineering apps. You can now connect these apps to share data and calculations seamlessly and collaborate more efficiently using the API.

Scalable plugins

You can now create your own plugins for popular software applications like Revit, ETABS, Excel, and more, so you can read and write data from VIKTOR or access engineering logic stored in your apps.

This approach offers greater flexibility and scalability than storing your logic in the plugin. Having the logic stored in a central location makes it easier to create the same plugins for different software packages.

Microservices

With the API, you can turn any VIKTOR app into a microservice. This means you can request the app to calculate and provide the results from Python, Grasshopper, Dynamo, Excel, or any other software.

Advanced data analysis

Create advanced data analysis tools, for example, to monitor adoption, calculate ROI, or perform internal billing. Using the Audit Events, Workspace, and Apps API, you can get information about apps, workspaces, and how your colleagues use them.

The latest updates

During the beta testing phase, we gathered your feedback and used it to improve the API, which is readily available starting today!

Improved docs

We gave the API documentation a refresher and added examples in all popular programming languages. The docs cover all use cases we've seen during beta testing, and we are committed to covering new use cases as they arise.

Easier authentication, also with SSO

You can authenticate using the API with Personal Access Tokens (PAT). The PAT makes using the API easier and enables single sign-on users to use it too. You can create and reset your PATs at any time.

Use the SDK's API module outside your apps

SooYou can use the API module in your apps, for example, to get information from other entities. Additionally, you can now also use the same classes and methods to access your apps from outside the platform using Python. Just pip install viktor and use the API module in your script. See the docs for more information.

What's next

We are committed to continuously enhancing the VIKTOR API, and we need your feedback to do so! We invite everyone to test the API, share their experiences, and contribute to its development. Your input is invaluable in shaping the future of VIKTOR's API, so please share your thoughts and suggestions on our Community Forum.

We feel the API already provides a solid base for data exchange, and soon, we will release a new version that will make it easier to use the logic of your apps and run calculations through the API.

We will also share open-source examples to demonstrate the API's capabilities in real-world scenarios. Stay tuned for updates and join us on this exciting journey of harnessing the power of VIKTOR's API.