README.md

WebTrendsSDK

A .NET SDK built for the WebTrends OTS API

Installation

The SDK is available as a NuGet package. You can install it using the following command:

dotnet add package WebTrendsSDK

Usage

.NET Core & .NET 5+

You can easily add the WebTrendsSDK to your project by referencing the NuGet package and adding the following configuration and service registration:

{
  "WebTrends": {
    "AccountId": "<account-id>",
		"KeyToken": "<key-token>"
  }
}

services.AddWebTrends();

This will register a default per-request IWebTrendsApiClient instance in the service collection. You can then inject this into your services and use it to interact with the WebTrends API.

.NET Framework

For use on .NET Framework would largely depend on your dependency injection strategy (if you use one).

You can easily create an instance of the WebTrendsApiClient class and use it to interact with the WebTrends API.

var http = new HttpClient();
var client = new WebTrendsApiClient(http, new WebTrendsSettings());

Or, alternatively through the API client factory:

var clientFactory = new WebTrendsApiClientFactory(new WebTrendsHttpClientFactory());
var client = clientFactory.CreateClient(new WebTrendsSettings());

NOTE - On .NET Framework, it is recommended to use a single instance of HttpClient for the lifetime of your application. This is because the HttpClient class is designed to be reused and not disposed of after each request.

A IWebTrendsHttpClientFactory can be implemented to manage the lifecycle of the HttpClient instance.

Debugging

To aid in debugging results from the WebTrends API, you can enable the following settings:

{
  "WebTrends": {
		"CaptureRequestContent": true,
    "CaptureResponseContent": true
  }
}

These settings, when enabled will capture the request and response content for each API call, and the content of these will be available to the WebTrendsResponse as RequestContent and ResponseContent properties. The SDK will automatically map these results, but for unexpected results, it is useful to understand what has been sent/received.

Open Source

This SDK is open source and is available under the MIT license. Feel free to contribute to the project by submitting pull requests or issues.

Component	Authors	Website	License
.NET Platform	Microsoft and contributors	GitHub	MIT
Ben.Demystifier	Ben Adams	GitHub	Apache V2
FluentValidation	Jeremy Skinner and contributors	GitHub	Apache V2
Docusaurus	Meta Platforms, Inc and contributors	GitHub	MIT
MinVer	Adam Ralph and contributors	GitHub	Apache V2

By using this SDK, you agree to the terms of the MIT license used by this project, as well as the terms of the licenses of the components used by this SDK.