UI Integration Framework

It's a set of tools for getting presence for your app inside Egnyte UIs.

Currently Web UI supports this framework and adding it to desktop clients is on the roadmap. We are also considering a limited version of this for mobile apps.

Basic concepts

App definition - a json file with metadata about the app necessary to register it as a UI integration. When you start developing a UI integration, make sure you get a development environment with access to App Definition Form (ask your partner account manager or get in touch)

Invocation - the process of calling a 3rd party app (your app!) from Egnyte UI.

Invocation's access token - the token that's sent along with invocation is scoped to allow you to use FS API, Users API and Permissions API. You can request a different scope by setting it in the API definition, see App definition docs

Security

Invocation is passing Public API access tokens to your app. We require that you handle the token securely and we will check it in certification. You cannot expose the token to the browser anywhere in the process of Invocation. You need to make sure users' access to Egnyte or your application is not leaked to browsing history or any third-party.

Detailed documentation

• UI Invocation flow
• App definition docs
• For app definition, you'll only have to write the content for the integrations field manually, everything else is separate fields in the App Definition Form.
• User and domain Settings - settings are there in case you really need them, but we recommend building UI integrations in a way that doesn't need a settings screen, but asks for settings on first invocation.