Welcome to the OpenHue SDK documentation. This guide will help you get started with integrating and using the OpenHue SDK in your project.
- API version:
v2 - SDK version:
1.0.0
This SDK is compatible with the following versions: C# >= .NET 6
To get started with the SDK, we recommend installing using nuget:
dotnet add package OpenHueThe 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.
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")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);The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
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.
Below is a list of all available models with links to their detailed documentation:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.