From the Connection tab, you can configure the required settings.
Procedure
- From the Config Tool home page, open the Plugins task.
- In the Plugins task, select the plugin role from the entity browser, and click the Connection tab.
- Select between SFTP and HTTPS connection method.
-
If you selected HTTPS connection, configure the following:
HTTPS connection
Server URL
API base server URL.
Endpoint methods
Completed sessions
Enter the API method for completed sessions export. Click Test the connection to test the connection.
Violations
Enter the API method for violations export. Click Test the connection to test the connection.
Occupancy
Enter the API method for occupancy export. Click Test the connection to test the connection.
Authorization settings
Select the authorization type as determined by the third-party API provider:
Password Grant
Credentials by the third-party API provider (Password Grant - OAuth 2.0 Simplified)
Setting Description Token URL Authentication server URL (from which to retrieve the authentication token). Client ID OAuth Password grant client ID. Client secret OAuth Password grant client secret. Username OAuth Password grant username. Password OAuth Password grant password. Scope OAuth Password grant scope (optional). Test connection Test the retrieval of a valid token with the provided credentials. Client Credentials
Credentials by the third-party API provider (Client Credentials - OAuth 2.0 Simplified)
Setting Description Token URL Authentication server URL (from which to retrieve the authentication token). Client ID OAuth Client credentials client ID. Client secret OAuth Client credentials client secret. Scope OAuth Client credentials scope (optional). Test connection Test the retrieval of a valid token with the provided credentials. Static token
Static token provided by the third-party API provider.
Setting Description Static token A static token to be added to the header of the requests for authorization.Note: There’s no test button because the token can’t be tested. -
If you selected SFTP connection, configure the following:
- Destination folder
- Enter the path of the destination folder.
- Hostname or IP
- Enter the IP address or the hostname of the destination server.
- Port
- Enter the port number of the destination server.
- Username
- Enter the username provided by the API.
- Password
- Enter the password provided by the API.
- (Optional) SSH private key
- Enter or browse the path to SSH private key provided by the third-party provider.
- (Optional) SSH passphrase
- Enter the value provided by the third-party.NOTE: If you enter a SSH private key, you need to enter a SSH passphrase.
- Test connection
- Click this option to test the connection.
- Click Apply.