To rotate ConnectWise API keys, we'll follow these steps:
- Create a new API Key (to replace the old one)
- Update API details in ZenContract
- Verify the updated API key
- Disable the old API member
1. Create a new API Key
To reach the API keys section In ConnectWise
- go to System, then Members
- click on the 'ZenContract' member ID
- click on the 'API Keys' tab at the top
On the far left, click on the + symbol to add a new API key.
Give the key a name (eg "ZenContract_YYYYMMDD" with today's date) and click the black save icon (to the right of the + symbol).
The Public and Private keys will appear ONLY ONCE. Make sure to copy and paste that key to a separate area, like Notepad or Word, for later usage. This will not be accessible later so DO NOT MISS THIS STEP.
2. Update API details in ZenContract
Log into your ZenContract account, and click on the Admin/Settings item in the main menu.
Click on the Integrations tab and choose the ConnectWise sub-tab.
Copy the Public Key and Private Key from Step 1 and paste them over top of the existing keys in the respective fields in ZenContract. Then click Save Changes.
3. Verify the update API key
After clicking Save Changes, a "test connection" pop-up window will appear. Click on the blue OK button to test the connection.
If the connection succeeds, you will see a green Connection Success message.
If the connection fails, you will see a red Connection Failed message. Please retry the steps above or contact support@zencontract.com for assistance.
4. Disable the old API Key
Open the old API key, select the 'Inactive' checkbox, then click the black 'Save' icon to the right of the '+':
You can delete this API key once you're satisfied the API Key rotation is complete.