Configure API Keys in ConnectWise for PSA Integration in the Umbrella MSP and MSSP Consoles

Introduction

This document describes how to create API keys in ConnectWise for PSA Integration in the Umbrella MSP and MSSP consoles.

Overview

Starting in February 2020, all Umbrella MSP and MSSP customers wanting to create a PSA Integration with ConnectWise have to use a public and private key (rather than a username and password, as previously used).

Creating the Keys

To create those keys, please do this in ConnectWise:

1. Click System -> Security Roles ->  “+” icon to create a New Role.
2. Enter a Role ID name such as “Umbrella”.
3. Click the Save icon.

newrole.png

4. Configure these Security Modules for the newly added Role:

• Companies -> Company Maintenance: Inquire Level: All.
• Companies -> Configurations: Add Level: All; Edit Level: All; Inquire Level: All.

companies.png

• Service Desk -> Service Tickets: Add Level: All; Edit Level: All; Inquire Level: All.

Manage__Security_Roles_servicedesk.png

• System -> Table Setup -> click “customize” and set “Allow Access to these” to "Company / Configuration" and "Service / Priority" and "Service / Service Board", then click Save.

Manage__Security_Roles.png

• System -> Table Setup -> Add Level: All; Edit Level: All; Inquire Level: All.

tablesetup.png

5. Click the Save And Close icon.
6. Click System -> Members -> API Members -> “+” icon to create a new item.
7. Set Role ID to the newly created Role (named "Umbrella" in step 2 above). Fill in the other values as desired, then click the Save icon.

roleid.png

8. Click API Keys -> “+” icon to create a new item. 
9. Enter a Description, then click the Save icon.
10. Copy down the API Public Key and Private Key values for use in the Umbrella MSP or MSSP console.  Note: The private key is only available at the time the key is created. Please make a note of it.

apikeysecret.png

If you have an existing PSA integration with ConnectWise, enter the API key values in the Umbrella MSP (or MSSP) console --> MSP (or MSSP) Settings --> PSA Integration Details --> Enabled [beneath Credentials] --> fill in the "Public API Key" and "Private API Key" values --> Save.