2024 @ NDI Vizrt AB.
The NDI Bridge Service web page provides an API reference, runtime status information, webhook management, WebSocket management, and API key management if SSL is enabled.
Figure 6: Main page
The upper left-hand corner of the web page includes the status pane, which provides information about the current status of NDI Bridge Service.
Version: This indicates the version of NDI Bridge Service that is installed and running.
Uptime: This indicates the length of time NDI Bridge Service has been running. This is not the length of time Bridge is running. NDI Bridge Service can be running without Bridge itself running in Host or Join mode.
Is Running: This indicates whether Bridge is running in either Host or Join mode.
Runtime Mode: This indicates which mode Bridge is running in: HOST for Host mode or JOIN for Join mode.
Discovery Server Status: This indicates that the NDI Discovery Server, a component required for Bridge to function properly, is running in the background.
Figure 7: Status pane
If SSL is enabled and properly configured, you will see an API Keys section on the left-hand navigation menu. On this page, you can add and remove API keys required for accessing the API when SSL is enabled.
Figure 8: API key management
To add an API key, click on the add button in the upper right-hand corner of the API Keys section on the page. You will be presented with a dialog where you can add a memo to help distinguish the purpose of this API key and set an expiration date.
Figure 9: API key creation
After selecting Create, you will be prompted with another dialog to copy the generated API key. You will not be able to retrieve this API key again, so save it somewhere before dismissing the dialog. For information on how to use the API key in a request, see the API section of this document.
Figure 10: API key copy
NDI Bridge Service uses a JSON configuration file to store settings, similar to the desktop Bridge application. The file is installed under:
ProgramData\NDI\NDI Bridge Service\service_settings.json
At the very top of this file are the same five fields that were present on the configuration page of the installer. You can manually modify these settings by following the rules below. Changes to these settings do not take effect until the NDI Bridge Service is restarted, either by restarting the machine or by restarting the NDI Bridge Service manually inside the Windows Service Console. Any invalid configuration, whether syntactic or semantic, will result in the configuration file being reset to its default when the service restarts, or a failure to start the service.
"port": 8080, "useHttps": false,
"enableWebContent": true, "certificateSubject": "cn=", "hostBinding": "127.0.0.1",
port: This is the port that the web server uses to provide access to the web interface and APIs. This is not the port used by Bridge in Host or Join mode; that is configured via the API along with all other Bridge settings.
useHttps: true or false, this field enables or disables SSL. If set to true, you must also provide a valid value for the certificateSubject field.
enableWebContent: true or false, this field determines if the web interface should be accessible. If set to false, only the API will be accessible and no web content will be presented at the URL.
certificateSubject: If useHttps is set to true, you must also provide a valid certificate subject in Common Name format (CN=). SSL certificates must be installed in the local machine certificate store under the logical store path ’Personal/Certificates’, as this is the only location NDI Bridge Service looks to find your certificate with a matching CN subject.
To install an SSL certificate on your machine, simply double click the certificate file to open the import wizard. Be sure to select the ’Local Machine’ option before proceeding.
Figure 11: Certificate import
When prompted to select a certificate store, either use the automatic option, or manually select the personal certificate store.
Figure 12: Certificate store
hostBinding: This is the interface that the web server listens on. You can change this to target any particular interface on the machine or use 0.0.0.0 to target all interfaces. If you use 127.0.0.1 then the web interface and API will only be accessible on the local machine.
If you are using SSL and have the web interface disabled, you will have to use the command line to is-
sue and invalidate API keys. Navigate to the install directory and locate Application.NDI.Bridge.Service.exe. This application takes the following command line arguments to manage API keys.
NOTE: The service must be stopped before modifying API keys, you can stop it in the Windows Service Console.
newkey This argument will prompt you to provide a memo to help identify the purpose of this API key, and the number of days this key will be valid from the current UTC time.
listkeys This argument will provide a list of all API keys that have been issued.
removekey This argument will prompt you to enter in the ID corresponding to the API key you with to invalidate.
Figure 13: Command line interface
