Applies to: IVION

If you’re a regular user of NavVis IVION, you might have asked yourself: Is there a way to integrate this more deeply with my other software? Or to change this part of the user interface? Can I build bespoke workflows and services for my own use cases? 

Good news! The answer is yes. NavVis offers two APIs that enable developers to perform those customization tasks — and a lot more — by building custom scripts and applications based on data or functionality from NavVis IVION. The API gives developers a variety of tools that turn NavVis IVION into an extremely flexible platform for working with 3D spatial data. 

This article aims to get you started with the IVION REST API and the Frontend API. 

Please note:

In order to use the IVION APIs, it's necessary to have development capabilities in-house or contract out to a competent third-party developer. Our IVION APIs simplify the work of building custom scripts and applications, but they are intended for use by developers and are not intended for users which have no development background. If you need further help with this please don't hesitate to approach your Customer Success Manager. 

What is an API?

An API is an Application Programming Interface that allows NavVis to expose its application’s data or functionality to third parties.

In order to learn more about the fundamentals of the NavVis APIs please refer to this blog article which gives a good overview.


What is the Frontend API?

NavVis’ frontend API enables you to control, enhance, or customize NavVis IVION programmatically. More specifically, you (or your developers) can use JavaScript or TypeScript to embed NavVis IVION in a webpage and create a user interface specifically designed for your needs or use cases.

What can you achieve by using the IVION Frontend API?

  • Customize NavVis IVION to match your organization’s visual branding.
  • Change the sidebar menu or other UI elements to suit your needs.
  • Add new UI elements.
  • Control NavVis IVION remotely to offer interactive experiences to clients, for example, automated walkthroughs.
  • Configure NavVis IVION to “listen” for user actions and react in helpful ways.
  • Design and build custom workflows, such as defect tracking.
  • And more...

How to get started with the IVION Frontend API?

In order to get started with using the Frontend API please refer to our developer documentation. Additionally, also refer to our How-To-Guides where customization examples are explained.

Where to find sample applications built with the NavVis IVION Frontend API?

In order to get you started we provide different sample applications that can be downloaded here.

Where to find information on the endpoints with detailed descriptions of method signatures and types?

Endpoints and types can be found here.


What is the REST API?

A REST API is an API that meets the design criteria of a REpresentational State Transfer architecture. In short, the REST API offers access to NavVis IVION functions that run in the background. You (or your developers) can use API endpoints and HTML requests to access data and functions in IVION that aren’t available through the UI.

What can you achieve by using the IVION REST API?

  • Add IoT functionality and display sensor data charts in dialogs for any point of interest (POI).
  • Obtain artifacts from processed data sets.
  • Make bulk changes to users.
  • Make bulk changes to access permissions.
  • Automatically retrieve and update POI data.
  • And more...

How to get started with the IVION REST API?

In order to access the IVION REST API it's necessary to fetch a JWT token. Please follow this link to understand the concept.

The requests for the REST API can be found by following this link.

Written in [October] [2022]