Technical survey

The Technical Survey helps define the technical scope of the Clowder integration. In this survey, system administrators provide the following information:

Technical contacts
Test accounts
User access logic
Firewall rules and definitions
Integration system
API endpoint
Software portal access

Technical contacts

Technical contacts refer to the personnel responsible for the technical side of the Clowder integration.

Contact type	Description	Details required
Client Technical Contact	The personnel to contact on the client's side for technical questions and concerns. This person knows the details of the software to be integrated with Clowder.	Name and email address
Client Solution Provider/Consultant	The person to contact with questions and concerns about the software the client wants to integrate with Clowder.	Name and email address
Clowder Client Advisor	Provides support and direction during the integration phase. To be determined by Clowder.	Name and email address
Clowder Integration Manager	Personnel responsible for the integration on the Clowder side. To be determined by Clowder.	Name and email address

Test accounts

Test accounts help validate Clowder behavior after integration for different account types. For example, clients may want member accounts to behave differently from admin accounts and non-member accounts.

The basic types of test accounts are:

Member accounts – Test regular member accounts' behavior in the integration.
Non-member accounts – Test non-member accounts' behavior in the integration.
Staff accounts – Test admin and staff accounts' behavior in the integration.

For each account type, the client must provide a username and password once an account with the relevant permissions has been created in the target software. Clowder has also specified the emails associated with these accounts, and these emails must remain unchanged.

For reference, here are the email addresses associated with different account types:

Member 1 – [email protected]
Member 2 – [email protected]
Non-member – [email protected]
Staff – [email protected]

User access logic

User access logic helps Clowder define user roles and permissions (for example, who to consider a member or non-member). When user access logic is properly defined, feature visibility and app access are configured to meet exact user needs.

Firewall rules and definitions

Some organizations host their target software on-premises. In these cases, the organization governs the software with applicable firewall rules. If so, the organization must ensure that Clowder IP addresses are added to their firewall exception or approval lists.

If unsure of how to complete this task, contact the Client Technical Contact or the IT department.

Integration system

The Integration system section provides information on the target software system, including:

Name (for example, iMIS)
Authentication type (for example, OAuth)

API endpoint

An API endpoint is the URL where Clowder pulls the resources it needs from the target software. A software may have multiple API endpoints. In this section, provide only the endpoints Clowder needs to access. If unsure, speak with a technical contact.

The table below presents some of the information required under the API endpoint, including their descriptions and sources:

Information	Description	Source
API endpoint URL	URL pointing to the software's API.	Client
Clowder redirect URL	Links to redirect users from the mobile app to the client's website.	Clowder
Client IDs	Single Sign-On (SSO) requirements. The client must set up their Single Sign-On application for Clowder in their AMS.	Client
Secrets	SSO secret in line with the Client ID implementation	Client

Software portal access

Clowder requires administrator access to the target software portal. To do so, the client must create a unique account with a full license using the email address: [email protected].

If the client's software has a member portal, the client must create a unique account for both the admin portal and member portal, then submit the credentials to the Clowder team.

📘
NOTE
If integrating iMIS with Clowder, the Clowder team will request an additional licensed user and add it to the client's site at no additional cost. For more information, see Adding a Clowder contact in iMIS.