Introduction

Build user-interface applications for IVION using the IVION Frontend API.

What is the IVION Frontend API?

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

Note: Frontend API access is included with IVION Professional and IVION Enterprise.

What you can achieve using the IVION Frontend API:

• Customize 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 IVION remotely to offer interactive experiences to clients, for example, automated walkthroughs.

• Configure IVION to "listen" for user actions and react in helpful ways.

• Design and build custom workflows, such as defect tracking.

• And more...

Further support

For more information about IVION Frontend API refer to the following:

• Different sample applications that can be downloaded here.

• Endpoints with detailed descriptions of method signatures and types here.

• In IVION, Frontend development is based on an NPM package, for information click here.

• Download the NPM package here.

• The IVION Frontend API allows IDE users to access auto-completion features and provides TypeScript users with type-safety features, for more information click here.

How-To Guides

Customize your instance with the IVION Frontend API.