Authenticate Using API Member

ConnectWise is a business process automation platform that allows businesses to sell, service, and support technology more efficiently and in a more streamlined way. The business management tool allows a business to centralize all information, automate business processes, real-time visibility in operations, and provide better customer support.

The app can also be used for ticket management, help desk management, project management, customer relationship management, time tracking, asset tracking, billing and invoicing, technician dispatching, procurement, inventory management, among others.

This article explains how to authenticate with a ConnectWise account in the MBS Management Console via API member (recommended).

API Member

API Member is a ConnectWise entity that gives access to a ConnectWise Manage account. API Member usually has restricted access that allows performing different operations through programming API.

Before creating a new API member, however, you first need to create a Security Role that will give the required permissions to an API Member.

The following permissions must be granted:

  • Company module —> Company Maintenance function:
    • Inquire Level - All
  • Company module —> Contacts:
    • Inquire Level - All
  • Finance module —> Agreements function:
    • Inquire Level - All
    • Add Level - All
    • Edit Level - All
  • Finance module —> Company Finance function:
    • Inquire Level - All
    • Add Level - All
    • Edit Level - All
  • Procurement module —> Product Billable Option function:
    • Inquire Level - All
    • Add Level - All
    • Edit Level - All
  • Procurement module —> Product Catalog:
    • Inquire Level - All
  • Procurement module —> Products:
    • Inquire Level - All
  • Service Desk module —> Service Tickets function:
    • Inquire Level - All
    • Add Level - All
    • Edit Level - All
  • Service Desk module —> Close Service Tickets function:
    • Inquire Level - All
    • Edit Level - All
  • System module -> Table Setup function:
    • Inquire Level - All.

Once you granted the Table Setup permission, click Customize and make sure the following entries are listed in the Allow access to these columns: Service / Service Board

To create a new security role, proceed as follows:

  1. Log in to the ConnectWise Manage console.
  2. In the System menu, select Security Roles.

  1. Click +.

  1. Once the security role along with the required permissions is created, proceed to create an API member.
  2. Select System, then select Members.

  1. Switch to the API Members tab.
  2. Click +.
  3. Fill in the required fields.
  4. Select the security role created on steps 1-4 and assign it to the API member.

  1. Once you are done, click the Save icon.
  2. Once the API member is created, switch to the API Keys tab.

  1. Create a new pair of API keys. Save them to a safe location.

Note that you will not be able to retrieve API key pair information again, so in case you lose it, you will need to create a new API key pair

Authentication in the Management Console

To authenticate with ConnectWise API member keys in the Management Console, you need to provide three credentials:

  • Member ID. You can find it in the Details tab

  • A public key and a private key. You can find those in the API keys tab

Note that if you create or edit a description, a new pair of public and secret keys is generated

Once you specify all required credentials in the Management Console, click Save.

To check for missing permissions, click Check Member Permissions.

https://git.cloudberrylab.com/egor.m/doc-help-mbs.git