Skip to main content

Settings - Web API​

The Web API tab turns the VisualCron Web API on or off and sets its ports and certificate. The Web API lets other programs work with the Server through a REST service and a web service. To learn how to call it, see VisualCron Web API. This tab is one of the tabs of the Server settings window (see Main - Settings).

Server -> Main settings -> Settings -> Web API tab

The Web API tab with Allow Web API checked, the Unencrypted box with port 8001 and its Web service, REST service and REST service documentation links, and the Encrypted box with port 8002, Use self signed certificate, Use user certificate and Force Windows Authentication

  • Allow Web API: turns the Web API on. Unchecked by default. When it is on, the Server opens both the unencrypted and the encrypted port
  • Unencrypted -> Port: the HTTP port. The default is "8001"
  • Encrypted -> Port: the HTTPS port. The default is "8002"
  • Use self signed certificate (default) or Use user certificate: the certificate of the encrypted port. With Use user certificate, select a certificate from the global Certificates (see Global - Certificates). If you click Apply settings without one, VisualCron shows "You must specify a certificate!". The self signed certificate is created by VisualCron, so programs that call the encrypted port must be set to trust it. Use a certificate they already trust if they cannot
  • Force Windows Authentication: on the encrypted port, users log on with their Windows account instead of a VisualCron user name and password. Available only while Allow Active Directory Logon is checked on the Users/Logon tab (see Settings - Users/Logon). If you uncheck Allow Active Directory Logon, this option is unchecked too

Each box shows links to the Web service description, the REST service and the REST service documentation for its port; click a link to open it in your browser. The REST service link of the Unencrypted box is an example logon address with a sample user name and password. In the Encrypted box, the REST service link opens the documentation address.

Changes take effect when you click Apply settings: the Server restarts the Web API with the new ports, certificate or authentication. VisualCron does not open the Web API ports in Windows Firewall.

warning

The unencrypted port is always open while Allow Web API is checked, and it does not use Windows authentication, even when Force Windows Authentication is checked. A REST logon sends the user name and password in the address, so on the unencrypted port they travel in clear text. To protect them:

  • Use only the encrypted port in your scripts and programs
  • Allow only the encrypted port through Windows Firewall, and do not add an inbound rule for the unencrypted port
  • After logon, use the token that the logon returns for later calls (see VisualCron Web API)

Most examples on the VisualCron Web API page use the unencrypted port with "http" and port "8001". Use "https" and the encrypted port instead.