OpenHue 1.0.1

OpenHue C# SDK 1.0.0

Welcome to the OpenHue SDK documentation. This guide will help you get started with integrating and using the OpenHue SDK in your project.

Versions

• API version: v2
• SDK version: 1.0.0

About the API

See openhue/openhue-api

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • API Key Authentication
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: C# >= .NET 6

Installation

To get started with the SDK, we recommend installing using nuget:

dotnet add package OpenHue

Authentication

API Key Authentication

The OpenHue API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

using OpenHue;
using OpenHue.Config;

var config = new OpenHueConfig()
{
	ApiKeyAuth = new ApiKeyAuthConfig("YOUR_API_KEY")
};

var client = new OpenHueClient(config);

If you need to set or update the API key after initializing the SDK, you can use:

client.SetApiKey("YOUR_API_KEY")

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

using OpenHue;
using OpenHue.Config;
using Environment = OpenHue.Http.Environment;

var apiKeyConfig = new ApiKeyAuthConfig("YOUR_API_KEY");

var config = new OpenHueConfig
{
  Environment = Environment.Default,
ApiKeyAuth = apiKeyConfig
};

var client = new OpenHueClient(config);

var response = await client.Resource.GetResourcesAsync();

Console.WriteLine(response);

Services

The SDK provides various services to interact with the API.

<details> <summary>Below is a list of all available services with links to their detailed documentation:</summary>

</details>

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

<details> <summary>Below is a list of all available models with links to their detailed documentation:</summary>

</details>

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.