1. Create Security Role

ConnectWise API access functions under the rights of the assigned API account using role-based security. It is essential to avoid using a pre-existing role such as “Admin” for the API account. Instead, create a dedicated role with sufficient rights to perform necessary API actions.

Steps to Create a Role:

Navigate to Security Roles:

• In the ConnectWise user interface, go to System > Security Roles.

Create New Role:

• Click the plus (+) sign to create a new role.
• Use "CYRISMA" as the Role ID.
• Save the role to initiate configuration.

Assign Necessary Rights:

• Assign the following rights to the CYRISMA role to ensure adequate operational capabilities:
  • Companies > Company Maintenance: Inquire Level = All
  • Service Desk > Close Service Tickets: Add = All, Edit = All, Inquire = All
  • Service Desk > Service Tickets: Add = All, Edit = All, Inquire = All
  • System > API Reports: Inquire = All
  • System > Member Maintenance: Inquire = All
  • System > My Company: Inquire = All
  • System > Table Setup: Add = All, Inquire = All

Restrict Table Setup Rights:

• Further restrict the rights for Table Setup by removing excessive privileges. Click the “customize” link to access the detailed view.

• Update the security rights using the arrows to transfer access privileges, ensuring that all access is removed except for the specified rights.

2. Create API User

To enable CYRISMA to communicate with the ConnectWise PSA platform, you need to set up secure API credentials.

Steps to Create an API User:

Navigate to API Members:

• Go to System > Members and select the API Members tab from the top section of the ConnectWise interface.

Add New API Member:

• Click the plus (+) sign to open the New Member panel.
• Name the API user "CYRISMA" or a similar identifier for easy recognition of its purpose.
• Assign the newly created CYRISMA role ID to this API user.

Save Member Details:

• Use the save icon at the top to save the details of the API user.

Generate API Keys:

• While still in the Member panel, navigate to the API Keys tab and click the plus (+) icon to generate new credentials for the API member.
• Enter a meaningful description for the key and save the credential. This action will generate both a public and private key, which are essential for establishing the API integration.

Important Note:

• The Private Key will only be displayed at the time of generation. It is crucial to record this key securely, as it cannot be retrieved later.

Conclusion

Following these steps will ensure that the CYRISMA Agent is properly integrated with ConnectWise PSA through a secure API user and a dedicated security access role. This setup will facilitate effective communication and operations between CYRISMA and ConnectWise. If you have further questions or require assistance, please refer to the ConnectWise documentation or contact support.