API - Advanced Programming Interface
The API service is an active – active component and may be installed on any machine that has IIS configured.
The API component is divided into the following three parts to support three different usage areas:
- Provisioning API: Configure and provision the system
- Reporting API: Get system information and reporting data
- Control API: Add and manage external system tasks
Refer to the LUCS API manual for a full instruction on how to use the API.
Installation
- Run the Lucs.API.Setup.msi
On Luware-LUCS-API Configuration Settings screen fill in the following settings
| Key in LUCS API Configuration Settings | How to get the value |
|---|---|
| Instance Name | Enter the server instance name The setting is stored in C:\Program Files\Luware AG\API\AppSettings.config as <add key=‘InstanzName’ value=‘LUCS’/> |
| Port Number | Enter the server port number The setting is stored in C:\Program Files\Luware AG\API\AppSettings.config as <add key=‘PortNumberToAdd’ value=‘3500’/> |
| Site Port Number | Enter the site port number. The port number 80 is recommended for http and 443 for https. The used site port number should be not used by other sites. Please note: For Lucs-FE and Lucs-API installed on the same machine a site port numbers have to be different. The setting is stored in IIS. |
| Security Protocol | Choose the security protocol between http and https The setting is stored in IIS. |
| Configure Certificate Security | For security reason the system provides possibility to use certificate-based encryption and verification during the components communication. To configure certificate based authentication, select ‘Configure Certificate Security’ check box and press ‘Next’ button to open a page with server certificate settings. If the check box is ‘true’ the certificate settings has to be defined during the installation: – client settings specify which settings API will use while connecting to PS Note: The system reports all errors related to connection or certificate issues to a log file‘C:\Program Files\Luware AG\LUCS-ICH\log\connectionIssues.log’. |
When the installation is done, open Internet Information Services (IIS) Manager and make sure that the Luware-API is started:
Configuration
In the WebConfigurator application:
Open Topology -> Components (Server)
WebConfigurator - API Component ConfigurationAdd API component as it is shown in the example (select the API Server Type, System Instance, Activity Order and fill the service’s Settings according to the table below
Key Description ClientKeepaliveInterval Timeout between requests. Value is set in seconds. ClientKeepaliveIntervalTimeout Timeout between the reconnections. Value is set in seconds. MaximumPollingTimeoutInMin Timeout is set in minutes.
Task lifetime / expiry / refresh
If no polling happened during this timeframe the task gets disposed, because it seems "abandoned").
Overall maximum lifetime for a task is 5 days. If you want to keep it in the system you need to make a refresh request via API to let the system know you still "care" about this task.