.NET SDK Configuration and Usage

14min
This guide will walk you through the step-by-step process of configuring your LicenseSpring license using the LicenseSpring .NET SDK.
As you advance through this tutorial, you'll gain the expertise to activate, deactivate, and verify licenses directly from your .NET application.
Throughout this tutorial, functions and methods employed may throw exceptions to address potential issues.
For more information about these, see Error Handling﻿.
Configuration
To initialize the SDK, you must fill in your application name and version, LicenseSpring API key, shared key and product code.
Both the API key and shared key can be found on your LicenseSpring account under Settings->Keys:
API and Shared Key Location
﻿
Your product code is located in your product list under "Configure Products":
﻿
Please, keep in mind that the product code field is case-sensitive. 
When you have the necessary values, create the configuration as shown below:
C#
var configuration = new LicenseSpring.Configuration(
  apiKey: "API KEY",
  sharedKey: "SHARED KEY",
  productCode: "PRODUCT SHORT CODE",
  appName: "APP NAME",
  appVersion: "VERSION");
var configuration = new LicenseSpring.Configuration(
  apiKey: "API KEY",
  sharedKey: "SHARED KEY",
  productCode: "PRODUCT SHORT CODE",
  appName: "APP NAME",
  appVersion: "VERSION");
﻿
Now you can initialize LicenseManager using this configuration object:
C#
var licenseManager = LicenseManager.GetInstance();
licenseManager.Initialize(configuration); 
var licenseManager = LicenseManager.GetInstance();
licenseManager.Initialize(configuration); 
﻿
License Activation
The license keys are located in "Licenses" section on the vendor platform:
License Key Location
﻿
To implement user-based licensing please refer to: User-Based Licensing﻿.
To activate a license, create a LicenseID using the given key and call activation method.
C#
try 
{
  LicenseID licenseId = LicenseID.FromKey( licenseKey );
  var license = licenseManager.ActivateLicense( licenseId );
} 
catch( LicenseActivationException e )
{
  //...
}
try 
{
  LicenseID licenseId = LicenseID.FromKey( licenseKey );
  var license = licenseManager.ActivateLicense( licenseId );
} 
catch( LicenseActivationException e )
{
  //...
}
﻿
Note: ActivateLicense returns the activated License object if the activation is successful.
ActivateLicense can throw many different exceptions, for information on why they're thrown and how to handle them, see Error Handling﻿.
InvalidOperationException can occur due to incorrect use of the ActivateLicense function. This function has two overloads. For a regular license activation, it takes only LicenseID. The overload that takes strings is used for SSO. For more information, see Single Sign-On﻿.
License Deactivation
Deactivating a license unbinds the device from the license, and decrements the number of total activations. 
Depending on the license transfer policy, this usually means that the license is freed up to be activated onto a new device. 
Deactivating is done using the following method:
C#
var isDeactivated = license.Deactivate();
var isDeactivated = license.Deactivate();
﻿
Note: Deactivate()has an optional Boolean parameter that can be passed to determine whether the local license and folders created by the SDK should also be removed. This parameter is false by default.
Note: Deactivate()returns true if successfully deactivated and false otherwise. It also returns true if the license is already inactive.
Local License
The local license is a copy of the license information that is saved on the end user's local computer. Users who have not activated the license on their end before will not have a local license. By default, the local license is stored: %USERPROFILE%\AppData\Local\LicenseSpring\”Product Code”\License.key.
See Local License File﻿ for more information.
If a device already has a license, and you try to activate another license on that device, for the same product, that newly activated license will override the existing license, deleting it from the device. This will be on the developer to make sure that they check if a license exists on the device before a new activation.
The current license can be retrieved with:
C#
var currentLicense = licenseManager.CurrentLicense();
var currentLicense = licenseManager.CurrentLicense();
﻿
Note: If no active license is available, currentLicense will be set to null.
License Check
It is recommended to perform a local license check at application start to confirm that the local license file belongs to the current device and has not been transferred. 
A local license check is performed in the .NET SDK with:
C#
license.LocalCheck();
license.LocalCheck();
﻿
Note: It is also useful to check whether the local license file has been tampered with and whether the local license is still valid. 
Online license check refreshes the local license with the data from LicenseSpring backend are done with:
JS
var installationFile = license.Check();
var installationFile = license.Check();
﻿
This method also returns the most recent InstallationFile available for the license which can be useful for managing software updates.
For more information about managing software updates, see Handling Product Versions﻿.
You can also check for active, valid, enabled, and expired licenses using isActive, isValid, isEnabled, and isExpired methods respectively. 
Note that an active license does not necessarily mean a license is valid. A valid license means the license is active, enabled, and not expired. An active license means that the license is bound to a device, but may also be disabled or expired.
Full Code Sample
Below you can find a code sample that initializes the SDK, retrieves a local license or activates a new one, and performs the necessary checks.
C#
var configuration = new LicenseSpring.Configuration(
  apiKey: "API KEY",
  sharedKey: "SHARED KEY",
  productCode: "PRODUCT SHORT CODE",
  appName: "APP NAME",
  appVersion: "VERSION");
  
try
{
  var licenseManager = LicenseManager.GetInstance();
  licenseManager.Initialize(configuration); 
  var currentLicense = licenseManager.CurrentLicense();
  if( currentLicense == null )
  {
     LicenseID licenseId = LicenseID.FromKey( licenseKey );
     currentLicense = licenseManager.ActivateLicense( licenseId );
  }
  currentLicense.LocalCheck();
  currentLicense.Check();
}
catch (const LicenseSpringException& ex )
{
  Console.WriteLine("Exception encountered");
}
var configuration = new LicenseSpring.Configuration(
  apiKey: "API KEY",
  sharedKey: "SHARED KEY",
  productCode: "PRODUCT SHORT CODE",
  appName: "APP NAME",
  appVersion: "VERSION");
  
try
{
  var licenseManager = LicenseManager.GetInstance();
  licenseManager.Initialize(configuration); 
  var currentLicense = licenseManager.CurrentLicense();
  if( currentLicense == null )
  {
     LicenseID licenseId = LicenseID.FromKey( licenseKey );
     currentLicense = licenseManager.ActivateLicense( licenseId );
  }
  currentLicense.LocalCheck();
  currentLicense.Check();
}
catch (const LicenseSpringException& ex )
{
  Console.WriteLine("Exception encountered");
}
﻿
﻿
Updated 22 May 2024
Did this page help you?
.NET SDK Installation
.NET/C# Management SDK