Configuration

Configuration

Upon deployment, the following properties need to be configured. These may be a one-time configuration as part of the installation or vary with each deployed environment.

Port

Specifies the port number the web service API will communicate with. e.g. 44300

Base URL

Specifies the root address for all API methods on the machine. External applications will make their API requests via HTTP to the URL on the specified port. For example, if the API is hosted on server [192.168.1.10], running on port 44300, with a Base URL of "v1", all calls to the API will be of the form: https://192.168.1.10:44300/v1/...

Secure Sockets Layer (SSL)

For security purposes, all communication to/from the API is made via SSL (HTTPS rather than HTTP). To do this, an HTTPS binding must be configured in Internet Information Services (IIS).

Logging

Incoming/outgoing request information can be logged. This configuration setting specifies whether logging is turned on, the location of the output, and the level of messages to include.