iMIS integration: Prerequisites

Clowder uses the iMIS REST services to integrate, so the following information must be provided before the integration can begin:

• iMIS version: Confirm the exact iMIS version Clowder will integrate with.
• Single Sign-On (SSO) confirmation: Indicate whether SSO will be implemented.
• REST API endpoint URL: The base URL of the iMIS REST API endpoint (for example, https://imisserver.org/).
• Integration user credentials: Username and password for the iMIS account used for communication between iMIS and Clowder. This account must have remote access enabled and should not be configured as a SysAdmin account.

Provide all required information before development of the integration can begin.

Locating the iMIS version

To locate the iMIS version number, do the following:

1. Go to Settings > About iMIS.
2. Make note of the Software version.

Configuring Single Sign-On (SSO)

To use SSO for the iMIS-Clowder integration, it must be properly configured on the developer (dev) and production (prod) environments. The Clowder team provides the redirect URL for the appropriate environment.

SSO configuration consists of the following:

1. Creating an SSO client application. Ensure the following values are set:

   • Client ID - Clowder

   • Refresh token lifetime (minutes) - 30

   • Login redirect URL - Enter in the following format: https://exampleWebsite.com

     📘

     NOTE

     For example, https://acmeclowderapp.com.

     The Clowder team provides the redirect URLs for dev and prod environments. Create a unique SSO client application for each environment.

   • Enable Skip server endpoint validation.

     

2. Create a Single Sign-On page and add the Clowder SSO client application. For more information, see Setup Guidelines.

Obtaining the REST API endpoint URL

The REST API endpoint URL is your iMIS public website URL. For example, https://example.imiscloud.com or https://example.org. Whatever you use to access your public iMIS RiSE site, that is your endpoint URL.

Setting up the integration user credentials

If you need a dedicated user account to access the API, contact ASI Technical Support for additional information and next steps. There may be a cost associated with this licensed account.

Once you have the dedicated user account defined, ensure the account has the RemoteService role:

1. Go to Community > Security > Users.
2. Search for the account using the provided search filters.
3. Select the account Username.
4. Under User information, locate the Roles section, then select Add.
5. Enable the RemoteService role.
6. Click OK.
7. Click Save. The changes may take a few minutes to take effect.

Once that account is properly configured, send the username and password to Clowder.