C# SDK

Install and start using the C# SDK.

Intro

The LogChimp SDK provides access to the LogChimp REST APIs.

LogChimp is open-source customer feedback software: collect feedback as posts on boards, let users vote, and turn it into a public roadmap.

Installation

Add the SDK as a project reference into your solution:

Terminal
dotnet add reference <path-to-sdk>/src/LogChimp/LogChimp.csproj

The project takes its build settings from the files around it, so reference it in place.

Quick Start

Dependency Injection

Register the client with IServiceCollection and resolve it from the container. The HttpClient is managed by IHttpClientFactory. Configure the client's behavior through LogChimpClientOptions.

C#
services.AddLogChimpClient(options =>
{
    options.BearerAuth = "YOUR_BEARER_TOKEN";
    options.Environment = ServerEnvironment.Production;
    // TODO: configure more client options here
});

Direct Instantiation

Create the client by passing an HttpClient you manage yourself. Configure the client's behavior through LogChimpClientOptions.

C#
var httpClient = new HttpClient();
// TODO: configure more client options here
var options = new LogChimpClientOptions
{
    BearerAuth = "YOUR_BEARER_TOKEN",
    Environment = ServerEnvironment.Production,
};
var client = new LogChimpClient(httpClient, options);

On this page