Logo



Follow

Creating a ConnectWise RESTful API Key

 

1. Create an API Member. The Members screen can by found by going to the System Module and opening the Members page.  After accessing the Members page, click on the API Members tab.  Here you can create a new user and generate API Keys for them.

Make sure you give them the Admin Role. This means ALL permissions enabled under security roles for the member type. (see image at the end)

For the API Member there is no naming convention that should be followed. You can either choose to create a member strictly for DD to use as an API member, or you can create a generic API user. You can even use a regular (already existing) member account to create the API key, as long as it has Admin level access. 

chrome_2018-01-24_14-04-06.png 

 

2. Under API Members, go to API keys, and add a key for the API member you created. 

chrome_2018-01-24_14-04-23.png

3. Make sure to write down the private key somewhere else as it will only show up when it is created.

If you are migrating from SOAP to RESTful, then you will need to add the Public and Private key to your DeskDirector Instance. If you are a new client, then just add the details to the sign up form. 

4. Add the keys to your DeskDirector under the General Configuration > Integration Tab in the Admin Console. If you are changing from SOAP to REST, you will need to email DD Support at this point so they can enable the RESTful sync

chrome_2018-01-24_14-05-00.png

--------------------------------------------------------------

 

How the Security Role for the RESTful API member should look like:

Permissions.png