ZEN API is an interface to connect to a running ZEN application (with all its processes). Once connected, interaction is possible from an external process possibly running on another machine. The interaction includes, for example, the following:

• Monitoring, push-based where appropriate.
• Controlling
• Data streaming, for example, image data.
• Multi-client support

 

ZEN API is available in two modes:

• Supervised API Mode
• When in Supervised API Mode, the system prevents concurrent actions initiated from UI and API. The user has two possibilities:
• To enter API Mode: This mode allows the usage of any API calls, but mostly locks the UI.
• To use UI: In this case the UI is enabled, while only uncritical monitoring APIs are allowed to be called. Such API calls do not change the state of the system and thus do not create conflicts when executed at any time.
• Unsupervised API Mode
• This mode disables control synchronization and allows concurrent usage of UI and API (monitoring and controlling APIs), that is, it allows critical actions that may cause conflicts or errors when executed randomly, for example, moving the stage. This mode is meant for expert users.

 

Unsupervised API mode can be enabled under Home Screen >Maintenance > General Options > ZEN API.

To call ZEN API as a client, the following prerequisites must be fulfilled:

• The API client must always connect to the gateway.
• The API client must send API tokens.
• The API client must connect via TLS to the gateway.
• The API client must trust or know the certificate of the gateway.