Integration Services
Our development team is currently in the process of migrating supported integrations over to be Built-In. If a Built-In integration exists for the system you wish to communicate with then you should use that.
The Integrations section allows the connection to the EzeScan Integration Service (EIS).
This will then allows the operator to add an integration to one of the many supported EzeScan Integrations.
The EzeScan Server integration service should be installed and running prior to configuring in the WebApp.
Please refer to the EzeScan SERVER User Guide for instructions.
![](../../__attachments/441581585/image-20230913-070433.png?inst-v=59c6a4cd-ce4b-40b8-9de9-76dc92d7fb02)
Settings
The following settings are available:
Setting | Description |
---|---|
Integration Service Endpoint | Endpoint of integrations server. Often hosted locally. |
Ignore SSL Issues | Ignores any issues with the SSL certificate. Enabling this option potentially makes communication less secure. |
API Key | If your EIS server has been configured with an API Key then set this value to the corresponding key. |
If the settings are valid and the connection to EIS is successful then you will see the “Integration Server Status” table.
![](../../__attachments/441581585/image-20230913-070325.png?inst-v=59c6a4cd-ce4b-40b8-9de9-76dc92d7fb02)
On the right hand side you can click the Add New button to configure a new integration.
![](../../__attachments/441581585/image-20230913-070539.png?inst-v=59c6a4cd-ce4b-40b8-9de9-76dc92d7fb02)
Each integration will have specific settings for that particular system. If you need assistance then please contact us for help.
Integration Specific Documentation
Callback URI
Whenever an integration uses OAuth 2.0 flow it requires a callback URI.
The following API endpoint listens for OAuth 2.0 callbacks:
/api/integrations/oAuthCallback
When entering this URI into a destination system you need to add this URL onto the end of the URL you use to access EWA.
For example if you accessed EWA by navigating to:
https://hostame.domain.com/
Then your callback URI would be:
https://hostame.domain.com/api/integrations/oAuthCallback
The table below shows some common examples:
EzeScan WebApps Url | Callback URI |
---|---|
|
|
|
|
|
|
|
|
Placeholders
Integration settings support the following placeholders:
Placeholder | Description |
---|---|
| The current logged in users username |
| The current logged in users password |
Instead of using the username and password placeholders we recommend configuring integrations to use OAuth 2.0 flow for authentication when its supported.