Address WebSocket API Requirements
In addition to meeting product requirements, ensure that your site meets the following WebSocket API requirements.
Required roles: systems programmer, security administrator, storage administrator |
|---|
WebSocket APIs enable two-way communication with an API server. Subscribing to a WebSocket API service gives you access to outbound information as long as your connection lasts, without having to repeatedly poll the server. You can also send requests to the API service using the inbound channels. There are two WebSocket APIs in
NetMaster
:
- The Command Entry API
- The Open an Active SmartTrace API
Address WebSocket API Software Requirements
Before you configure and use a WebSocket API, ensure that your site meets the following software requirements:
- Ensure thatNetMasterversion 13.0 is installed and running and that all the latest maintenance has been applied to your runtime environment. In particular, ensure all PTFs relating to theNetMaster API Servicehave been applied.
- Ensure that you have a client that supports Streaming Text-Oriented Messaging Protocol (STOMP). The STOMP client enables you to subscribe to the WebSocket API endpoints.