Cloud Marketplace communicates with ConnectWise through API. The following API credentials are required:

  • Company ID
  • Public Key
  • Private Key
  • API Base URL, which are generated for a specific API member.


We recommend you create a new API member with a specific security role for this integration. To do this, complete the following steps.

Step 1 - Configuring a security role for an API member

  1. In the ConnectWise Manage control panel, go to System > Security Roles.
  2. Create a role with the following permissions:
PermissionLevelPurpose
Companies
Company MaintenanceInquire Level = AllRequired to list companies to import accounts and synchronize subscriptions
ContactsInquire Level = AllRequired to list company contacts to import accounts
Finance
AgreementsInquire Level = AllRequired to get company agreements with additions to synchronize subscriptions
Add Level = AllRequired to synchronize missing add-ons from Cloud Marketplace to ConnectWise
Edit Level = AllRequired to synchronize resource amount changes from Cloud Marketplace to ConnectWise
Delete Level = AllRequired to synchronize deleted resources from Cloud Marketplace to ConnectWise
InvoicingInquire Level = AllRequired to get the period the agreement is invoiced to set the proper dates for Additions
Procurement
Product CatalogInquire Level = AllRequired to get products defined in ConnectWise to synchronize subscriptions
Add Level = AllRequired to create automatically catalog entries in case no match is found
System
Table Setup
Inquire Level = All
Requires to get billing cycles to find out a billing cycle of an agreement
API ReportsInquire Level = All
Required to get the date of the latest agreement invoice



Step 2 - Creating a new API member

  1. In the ConnectWise Manage control panel, go to System > Members > API Members.
  2. Create an API member.


Step 3 - Generating API key

  1. In the ConnectWise Manage control panel, go to System > Members > API Members > Created_API_Member > API Keys.
  2. Generate an API key.


Note: The private key is only available for a short time on key creation