Obtaining ConnectWise API Credentials

Reseller Marketplace communicates with ConnectWise through API. The following API credentials, which are generated for a specific API member, are required:

  • Company ID,
  • Public Key,
  • Private Key,
  • and API Base URL.

We recommend that 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:

    Permission Level Purpose
    Companies
    Company Maintenance Inquire Level = All Required to list companies to import accounts and synchronize subscriptions
    Contacts Inquire Level = All Required to list company contacts to import accounts
    Finance
    Agreements Inquire Level = All Required to get company agreements with additions to synchronize subscriptions
    Add Level = All Required to synchronize missing addons from Reseller Marketplace to ConnectWise
    Edit Level = All Required to synchronize resource amount changes from Reseller Marketplace to ConnectWise
    Delete Level = All Required to synchronize deleted resources from Reseller Marketplace to ConnectWise
    Procurement
    Product Catalog Inquire Level = All Required to get products defined in ConnectWise to synchronize subscriptions
    Add Level = All Required to create automatically catalog entries in case no match is found
      Edit Level = All Required to update catalog entries when synchronizing product catalog
    System
    Table Setup Inquire Level = All Requires to get billing cycles to find out a billing cycle of an agreement
    API Reports Inquire 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.

 

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.