Connectwise.SDK.v2025.1 1.0.1

ConnectWise.SDK.v2025.1

A .NET 8.0 SDK for interacting with the ConnectWise Manage API (v2025.1), generated using OpenAPI Generator with library=restsharp.

This package provides a typed API client, authentication via API keys, and is ready for use in modern .NET dependency injection setups.

📦 Installation

Install via NuGet:

dotnet add package ConnectWise.SDK.v2025.1 --version 1.0.1

⚙️ Configuration

Add the following section to your appsettings.json:

"ConnectWise": {
  "ApiUrl": "https://api-na.myconnectwise.net/v4_6_release/apis/3.0",
  "ClientId": "your-client-id",
  "CompanyName": "your-company",
  "PublicKey": "your-public-key",
  "PrivateKey": "your-private-key"
}

🚀 Usage

ℹ️ Note: You will need to implement a small wrapper around the SDK to handle authentication and inject the required configuration. A sample is shown below.

1. Create a Wrapper Class

public class ConnectWiseApi : IConnectWiseApi
{
    private readonly ConnectWiseOptions _options;
    private readonly Configuration _configuration;

    public ConnectWiseApi(IOptions<ConnectWiseOptions> options)
    {
        _options = options?.Value ?? throw new ArgumentNullException(nameof(options));

        _configuration = new Configuration
        {
            BasePath = _options.ApiUrl
        };

        _configuration.DefaultHeaders.Add("Authorization", BuildBasicAuthHeader(_options));
    }

    private static string BuildBasicAuthHeader(ConnectWiseOptions options)
    {
        string credentials = $"{options.CompanyName}+{options.PublicKey}:{options.PrivateKey}";
        string base64Credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes(credentials));
        return $"Basic {base64Credentials}";
    }

    public string ClientId => _options.ClientId;

    public ITicketsApi TicketsApi => new TicketsApi(_configuration);
}

2. Register with Dependency Injection

public static class ConnectWiseServiceCollectionExtensions
{
    public static IServiceCollection AddConnectWiseApi(this IServiceCollection services, IConfiguration configuration)
    {
        services.Configure<ConnectWiseOptions>(configuration.GetSection("ConnectWise"));
        services.AddTransient<IConnectWiseApi, ConnectWiseApi>();
        return services;
    }
}

3. Inject and Use

public class TicketService
{
    private readonly IConnectWiseApi _connectWise;

    public TicketService(IConnectWiseApi connectWise)
    {
        _connectWise = connectWise;
    }

    public IList<ServiceTicket> GetTickets()
    {
        return _connectWise.TicketsApi.GetServiceTickets(_connectWise.ClientId);
    }
}

🧱 Features

• ✅ Strongly-typed SDK generated from OpenAPI spec
• 🔐 Basic Auth using CompanyName + PublicKey + PrivateKey
• 🧰 DI-ready with a custom wrapper
• 🧪 Built on RestSharp for RESTful calls
• 🏗️ Compatible with .NET 8.0

📁 Project Structure

• Api/ – Grouped API classes (e.g. TicketsApi)
• Model/ – Generated data models
• Client/Configuration.cs – BasePath and auth configuration

Note: You are expected to write your own ConnectWiseApi integration layer to inject auth headers.

🔐 Authentication Format

This SDK uses Basic Authentication in the following format:

Authorization: Basic base64(company+publicKey:privateKey)

This must be set manually in your wrapper.

🛠 ConnectWiseOptions

The ConnectWiseOptions class is a POCO that maps to your configuration section:

public class ConnectWiseOptions
{
    public string ClientId { get; set; } = string.Empty;
    public string ApiUrl { get; set; } = string.Empty;
    public string CompanyName { get; set; } = string.Empty;
    public string PublicKey { get; set; } = string.Empty;
    public string PrivateKey { get; set; } = string.Empty;
}

Make sure this matches the structure of the "ConnectWise" section in your appsettings.json.

📝 License

This SDK is generated code and provided as-is.
Use is governed by the terms of the ConnectWise API Agreement.

🤝 Contributing

Suggestions, fixes, or improvements welcome! Feel free to open an issue or submit a pull request.

🚀 Example Usage in Blazor

Here’s an example of how to consume the TicketsApi inside a Blazor component:

@code {
    [Inject] public IConnectWiseApi ConnectWiseApi { get; set; } = default!;

    private List<Ticket> ticket { get; set; }

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender)
        {
            ticket = await ConnectWiseApi.TicketsApi.GetServiceTicketsAsync(ConnectWiseApi.ClientId);
            StateHasChanged();
        }
    }
}

🧩 Example Usage in ASP.NET Core MVC

Here’s how you might use the SDK in a typical MVC controller:

using Microsoft.AspNetCore.Mvc;
using NavWise.ConnectWise.Client;
using Connectwise.Model;

public class TicketsController : Controller
{
    private readonly IConnectWiseApi _connectWiseApi;

    public TicketsController(IConnectWiseApi connectWiseApi)
    {
        _connectWiseApi = connectWiseApi;
    }

    public async Task<IActionResult> Index()
    {
        List<Ticket> tickets = await _connectWiseApi.TicketsApi.GetServiceTicketsAsync(_connectWiseApi.ClientId);
        return View(tickets);
    }
}