Configure CSAP Open API
Use Collaborate's open APIs to engage with the Collaborate services programmatically and enable any automation or integration with other systems in your environment. As an analyst, you can generate open API credentials for yourself, other analysts, and members of Collaborate.
Create Open API Roles
Create roles to control and restrict member access to Collaborate features. Assign the role to members while generating API credentials.
Steps
To create open API roles, follow these steps:
Go to Administration > Integrations > CSAP Integrations > Open API Permission.
Click Create Role or clone a default role by clicking Clone This Role. The default roles are Viewer and Admin. Use the following information:
Enter a name for the role in Role Name.
Select permissions for the role by using the toggle.
Select Active to activate the role
Click Create Role. You can now use the role while generating open API credentials for members.
Generate Open API Credentials
To gain Rest API access to Collaborate endpoints, you have to generate API credentials for your API user from the Analyst Portal. Assign a role to control and restrict members' access to Collaborate features. Analysts have access to all features.
Steps
To generate open API credentials, follow these steps:
Go to Administration > Integrations > CSAP Integrations > Open API Credentials.
Click Generate API Credentials. Use the following information while generating credentials:
Title: Enter the title for credentials. This title acts as an identifier for the generated credentials. For example, API Credentials for John Doe.
Select Analyst to generate API credentials for another analyst.
User: Enter the name and select the analyst user for whom you want to generate credentials.
If you want to share the credentials with the selected users through email, select Share via Email.
Note
Access to all alert-related open APIs is determined by the role and permissions associated with the selected analyst user.
Select Member to generate API credentials for members.
Organization: Choose an organization and select the member from the organization.
Member: Enter the name and select the member user for whom you want to generate credentials.
Role: Assign a role that you created in Integrations > Open API Permissions or choose an existing role to control and restrict members' access to Collaborate features.
(Optional) Allowed IP Addresses: Enter the allowed IP addresses to make sure that members can access Collaborate endpoints only from the specified IP addresses.
Click Generate to generate the credentials. You can now view the credentials. The credentials are also shared with the selected user if you have selected Share via Email.
Click Copy All to copy and save the Access ID, End Point, and Secret Key.
Click Download the .CSV to download the credentials. Ensure that you save the credentials for your reference because you cannot generate the same credentials again.
View Credential Details
After generating credentials for analysts or members, you can view the details in Open API Credentials.
Analyst: In this section, you can view all the credentials generated by analysts in the Analyst Portal.
Title: Displays the title provided for the API credentials.
Generated for: Displays if the credentials were generated for an analyst or a member.
Generated by: Displays the email address of the analyst who generated the credentials.
User: Displays the email of the user (analyst or member) for whom the credentials are generated.
Generated on: Displays the date and time when the credentials were generated.
Click the credentials to view more details such as when the credentials were last used, and the total number of API calls made using the credentials.
Member: In this section, you can view all the credentials generated by members in the Member Portal.
Title: Displays the title provided for the API credentials.
Generated by: Displays the email of the member who generated the credentials.
Organization: Displays the member's organization.
Generated on: Displays the date and time when the credentials were generated.
Click the credentials to view more details such as the name of the member, when the credentials were last used, the total number of API calls made, and other details.