The Create API Service button will install and activate the SmartConnect API on the current workstation for the current active SmartConnect instance. The workstation must have the IIS feature enabled in Windows in order for SmartConnect to be able to create and publish the SmartConnect API. The SmartConnect API should only be installed on one workstation for any particular SmartConnect instance, and not across multiple workstations.
The SmartConnect API is used for any real-time data sources or triggers, any use of the Excel Add-in or Excel Templates that allow users to run integrations directly from Excel, or any third-party system that calls into SmartConnect to run an integration on demand.
The buttons across the top of the window will perform different actions based on the current settings.
- Saves the current configuration and creates the web service (API) if it is not present yet. Only available once the credentials have been validated for the service.
- Cancels any changes made to the window since opening it.
- Starts the current web service (API) the configuration is tied to for the active instance. Applies to the current workstation.
- Stops the current web service (API) the configuration is tied to for the active instance. Applies to the current workstation.
- Removes the web service (API) from the current workstation that the configuration is tied to.
The different options allow the SmartConnect API to be configured during the setup process.
- Service Name
- The name of the web service (API) that will be published. Can be changed to differentiate multiple services on one workstation from another in the scenario where multiple SmartConnect instances are switched between. For most scenarios, the default name can be left in place.
- Port Number
- The port that the web service (API) will run under. Can be changed to any valid port within IIS and the environment. Useful for configuring a secure port for the API if opening to external access outside of the client network.
- Service User
- The windows account that will create and managed the web service (API). Must be an account with local admin rights to log any errors to the event viewer.
- User Password
- The password for the account used to run the service.
- The domain for the account used to run the service.
- Validate Credentials
- Will validate the account information entered can connect and create a windows service correctly. Validation must pass before the windows service can be saved and created.
- API Connection Timeout
- The length of time (in seconds) that the SmartConnect API will wait while trying to establish a connection.
- API Command Timeout
- The length of time (in seconds) that the SmartConnect API will wait while trying to execute a command within an open connection.
- API Debug
- Will enable debug logs to be written to the SmartConnect directory. Should not be left on for production environments unless troubleshooting an issue with API processes.