How to obtain ConnectWise credentials
Introduction
This article describes how to obtain the ConnectWise Manage credentials required for the Platform - ConnectWise integration setup. The integration uses the ConnectWise REST API to synchronize Organizations, Products, Agreements, Additions, and Invoice data between ConnectWise and the Platform.
To learn more about the ConnectWise integration, see this article: ConnectWise Integration
In this article:
- Required credentials
- Finding Company ID and Site URL
- Creating an API Member and API Keys
- Required permissions
Required credentials
To connect ConnectWise Manage with the Platform, you must provide the following credentials:
| Credential | Description |
|---|---|
| Site URL | Base URL of your ConnectWise Manage instance |
| Company ID | The identifier used when logging in to ConnectWise Manage |
| API Public Key | Public part of the ConnectWise API key pair |
| API Private Key | Secret part of the ConnectWise API key pair |
Finding Company ID and Site URL
The Company ID and Site URL are available directly from your ConnectWise Manage login page.
- Open your ConnectWise login page.
- Locate the Company ID field used during login.
- Copy the domain from your browser address bar. This is your Site URL.
Examples:- https://na.myconnectwise.net
- https://eu.myconnectwise.net
Creating an API Member and API Keys
To generate the API credentials required by the Platform, create a dedicated API Member in ConnectWise and generate API keys for it.
- Log in to your ConnectWise Manage instance.
- Navigate to System > Members.
- Open the API Members tab.
- Click the + button to create a new API Member.
-
Enter the API Member details:
- Member ID - unique identifier for the API user
- Member Name - descriptive display name
- Role ID - role with sufficient integration permissions
- Save the API Member.
- Open the newly created API Member and navigate to the API Keys tab.
- Click the + button to generate a new API key.
- Enter a description for the API key, for example: AppXite Integration API Keys.
- Save the API key configuration.
- Copy and securely store the following values:
- Public Key
- Private Key
Required permissions
The API Member assigned to the integration must have sufficient permissions to access and synchronize ConnectWise data.
Assign a Security Role with access to the following areas:
- Companies
- Procurement / Catalog or Products
- Finance / Agreements & Additions
These permissions are required so the integration can:
- Synchronize organizations and customer accounts
- Map and synchronize products
- Read agreements and additions
- Create and synchronize invoice-related records
Summary
This article explained how to obtain the ConnectWise credentials required for the Platform integration setup, including the Site URL, Company ID, API Public Key, and API Private Key. It also covered how to create a dedicated API Member and configure the required permissions for synchronization between ConnectWise Manage and the Platform.
Related content
Was this article helpful?
Articles in this section
- ConnectWise integration overview
- How to obtain ConnectWise credentials
- ConnectWise Setup Guide
- First steps with the ConnectWise integration
- Platform Contracts and ConnectWise Agreements
- Connectwise integration: Mapping organizations and products
- ConnectWise integration: Loading and syncing invoice lines
- Invoice lines in ConnectWise Manage
- Charge-date rules: how they affect Additions in ConnectWise
- ConnectWise integration: System Logs and troubleshooting
Add comment
Please sign in to leave a comment.