Hyland must request an API user key in order to gain API access to the customer's Encompass instance. This API user is used by the Integration to obtain the following:
- Documents from the Encompass eFolder
- Associated loan metadata used for document indexing
In order to request all required API keys, Hyland needs the Encompass Instance ID for each environment (both production and non-production) with which the customer plans to integrate their solution.
After receiving the keys, the Hyland implementation team obtains the following settings and their associated values:
|
Setting |
Description |
|---|---|
| Client ID |
Associated with the API user key to be used to authenticate OnBase to the Encompass environment. |
| Client Secret |
Associated with the API user key to be used to authenticate OnBase to the Encompass environment. Note: Hyland is not permitted to disclose the
Client Secret; a Hyland employee must
enter this value when the connection to the Encompass API is
configured.
|
| Instance ID |
The Encompass Instance ID where documents are archived from. |