KeyMint 1.0.1

dotnet add package KeyMint --version 1.0.1
                    
NuGet\Install-Package KeyMint -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="KeyMint" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="KeyMint" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="KeyMint" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add KeyMint --version 1.0.1
                    
#r "nuget: KeyMint, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package KeyMint@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=KeyMint&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=KeyMint&version=1.0.1
                    
Install as a Cake Tool

KeyMint C# SDK

A professional, production-ready SDK for integrating with the KeyMint API in C#. Provides robust, async-first access to all major KeyMint features, with strong typing and modern error handling.

Features

  • Async/await: All API calls are asynchronous.
  • Strongly typed: Request and response models for all endpoints.
  • Consistent error handling: All API errors are returned as structured result objects, never thrown as exceptions.
  • Logging: Integrates with Microsoft.Extensions.Logging for professional diagnostics.

Installation

Add the SDK to your project:

dotnet add package KeyMint

Usage

using KeyMint;
using KeyMint.Services;

var accessToken = Environment.GetEnvironmentVariable("KEYMINT_ACCESS_TOKEN");
var productId = Environment.GetEnvironmentVariable("KEYMINT_PRODUCT_ID");

if (string.IsNullOrEmpty(accessToken) || string.IsNullOrEmpty(productId))
{
    // Handle missing configuration
    throw new InvalidOperationException("Please set the KEYMINT_ACCESS_TOKEN and KEYMINT_PRODUCT_ID environment variables.");
}

var sdk = new KeyMintSDK(accessToken);

// Example: Create a key
var result = await sdk.CreateKey(new CreateKeyParams { ProductId = productId });
if (result.IsSuccess)
{
    var key = result.Data?.Key;
    // ...
}
else
{
    // Log or handle error: result.Error
}

Error Handling

All SDK methods return KeyMintResult<T>. Check IsSuccess before using Data. If IsSuccess is false, inspect Error for details. No API errors are thrown as exceptions.

API Methods

All methods are asynchronous and return a Task<KeyMintResult<T>>. Check IsSuccess before using Data. If IsSuccess is false, inspect Error for details.

License Key Management

Method Description
CreateKey Creates a new license key.
ActivateKey Activates a license key for a device.
DeactivateKey Deactivates a device from a license key.
GetKey Retrieves detailed information about a key.
BlockKey Blocks a license key.
UnblockKey Unblocks a previously blocked license key.

Customer Management

Method Description
CreateCustomer Creates a new customer.
GetAllCustomers Retrieves all customers.
GetCustomerById Gets a specific customer by ID.
GetCustomerWithKeys Gets a customer along with their license keys.
UpdateCustomer Updates an existing customer's information.
ToggleCustomerStatus Toggles a customer's active status.
DeleteCustomer Permanently deletes a customer and their keys.

For detailed parameter and response types, see the KeyMint API docs or use IntelliSense in your IDE.

License

MIT

Support

For help, see KeyMint API docs or open an issue.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 168 9/8/2025
1.0.0 167 9/8/2025