Only for ECS Staff
Cirrus has now available the Maintenance options required for external APIs configuration, which will allow staff users perform the current API integration with different applications or systems used by our customers and without needing to request the current script generation process.
These settings can be performed to any API integrated but, in this case, we will use the Cirrus - Nimbo example so it can be replicated with any other API needed in the future.
Only Superusers and Staff users are allowed to perform the described settings.
System Configuration
First, we will need to go to System :
Here, we will be able to see two different added settings, they will be visible only on System and to Superusers and staff users :
API Paths Configuration
External APIs Access Configuration
API Paths Configuration
This option allows you to see and edit (if needed) the paths of every configured API. Click on it to view every API and their paths (Activities section) :
Here, you will be able to search for any API integration. In our case, we selected the Nimbo API integration. If this information must be edited (missing path, change of path), click on Edit icon and enter the Path information.
Now, save the changes.
These URLs are oftenly already configured so we will be required to edit this information only in some particular cases (as in Training environments for Nimbo staging or Nimbo production).
External APIs Access Configuration
The second option allows you to configure the settings needed for autologin (for automatic connection between APIs and Cirrus). Click on it to enter (Activities section from Home menu) :
Here, you will be able to see every available API access currently active on Cirrus.
To add a new one, follow these steps :
Click on New Record.
2. Enter API login information :
Name
Host (URL)
Callback
Key Search and Secret key are automatically generated.
3. Save the changes.
Example for Nimbo :
After performing these two configurations for API integration, you can now go to the Client environment to enable their integration with Nimbo (or any other existing API).
Client Configuration
To perform the client settings, go to Client/Organization screen and in Client tab, go to the APIs Configuration section, then follow these steps :
Check the Nimbo Configuration box.
For Nimbo, enter the current Nimbo username and Nimbo Password.
Save the changes.
If any this user and password are modified, please update the details in this screen or Cirrus will not be able to communicate successfully with Nimbo.
FAQ
Does the external application require knowing the name and password of the linked user?
No, the external application will not be able to know the Cirrus username and password of the linked user, it will only receive an access token with which it will make requests from that user.
What happens if the user in Cirrus changes their password?
No change will occur in the connection, since when making the link it will be done using an access token, not with the Cirrus username and password, these are only used by the user in their request for the access token.
We hope this improves your Cirrus experience. Remember to share this information and ask for help if you need it.
Date: October 25, 2023.