.NET: Key - Devolens (formerly Cryptolens) Documentation

Methods that perform operations on a license key. A complete list can be found here: Key Namespace: SKM.V3.Methods
Version: 4.0.54. Both packages; all six documented target frameworks.

public static class Key

Public Module Key

These methods return a result object. Check Result == ResultType.Success before using its data. In version 4.0.54, handled request and JSON errors normally return ResultType.Error with a diagnostic Message. A non-null result alone does not mean the request succeeded. See Request Errors.

Signed Activation Example

Use SKM.V3, SKM.V3.Methods and SKM.V3.Models (with using in C# or Imports in VB.NET). Replace the demonstration product ID 3349, license key and credential placeholders with your own values. The access token needs the Activate permission. This example checks the API result and signature; see the FAQ below for the other license checks.

string accessToken = "YOUR_ACCESS_TOKEN";
string rsaPublicKey = "YOUR_RSA_PUBLIC_KEY";
string machineCode = Helpers.GetMachineCodePI();

var response = Key.Activate(accessToken, 3349, "ICVLD-VVSZR-ZTICT-YKGXL", machineCode);
if (response == null || response.Result == ResultType.Error)
{
    Console.WriteLine(response == null ? "No response." : response.Message);
}
else
{
    var license = LicenseKey.FromResponse(rsaPublicKey, response);
    Console.WriteLine(license == null ? "Signature verification failed." : "Signature verified.");
}

Dim accessToken As String = "YOUR_ACCESS_TOKEN"
Dim rsaPublicKey As String = "YOUR_RSA_PUBLIC_KEY"
Dim machineCode As String = Helpers.GetMachineCodePI()

Dim response = Key.Activate(accessToken, 3349, "ICVLD-VVSZR-ZTICT-YKGXL", machineCode)
If response Is Nothing OrElse response.Result = ResultType.Error Then
    Console.WriteLine(If(response Is Nothing, "No response.", response.Message))
Else
    Dim license = LicenseKey.FromResponse(rsaPublicKey, response)
    Console.WriteLine(If(license Is Nothing, "Signature verification failed.", "Signature verified."))
End If

Methods

Activate(string, ActivateModel)

Activates a license. Depending on the license settings, this can register a machine, start a trial, or acquire or renew a floating seat.

public static KeyInfoResult Activate(string token, ActivateModel parameters)

Public Shared Function Activate(token As String, parameters As ActivateModel) As KeyInfoResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`parameters`	`ActivateModel`	The parameters that the method needs.

Returns: KeyInfoResult. The API response. Check Result and Message before using the returned data. Checks: The SDK does not verify the returned license signature in this call. Verify the response using the corresponding signature helper. The access token needs the Activate permission. The SDK requests model version 3. When OSInfo is null, it attempts to collect OS information; use an empty string to prevent that automatic collection.

Activate(string, int, string, string, bool, int, int, string, string, string)

Activates a license. Depending on the license settings, this can register a machine, start a trial, or acquire or renew a floating seat.

public static RawResponse Activate(string token, int productId, string key, string machineCode = "", bool metadata = false, int floatingTimeInterval = 0, int maxOverdraft = 0, string OSInfo = null, string friendlyName = "", string LicenseServerUrl = null)

Public Shared Function Activate(token As String, productId As Integer, key As String, Optional machineCode As String = "", Optional metadata As Boolean = False, Optional floatingTimeInterval As Integer = 0, Optional maxOverdraft As Integer = 0, Optional OSInfo As String = Nothing, Optional friendlyName As String = "", Optional LicenseServerUrl As String = Nothing) As RawResponse

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token with the permission required by this API method.
`productId`	`int`	The product ID.
`key`	`string`	The license-key string.
`machineCode`	`string`	The machine or process identifier used for this activation.
`metadata`	`bool`	Whether to request metadata with the response.
`floatingTimeInterval`	`int`	The floating-seat interval, in seconds. Zero leaves floating activation disabled for this request.
`maxOverdraft`	`int`	Additional floating seats allowed above the configured limit. Defaults to zero.
`OSInfo`	`string`	OS information to send. Null allows automatic collection; an empty string prevents it.
`friendlyName`	`string`	An optional display name for the activation.
`LicenseServerUrl`	`string`	An optional License Server base URL.

Returns: RawResponse. A signed RawResponse. Pass it to FromResponse(string, RawResponse) to verify and decode the license. Checks: The SDK does not verify the returned license signature in this call. Verify the response using the corresponding signature helper. This overload requests signing with SignMethod.StringSign and model version 3. The access token needs the Activate permission. metadata defaults to false; metadata is not verified by LicenseKey.FromResponse. An empty OSInfo prevents automatic OS information collection.

AddFeature(string, FeatureModel)

This method will change a given feature to be true (in a license). If the key algorithm in the product is SKGL, the key string will be changed if necessary. Otherwise, if SKM15 is used, the key will stay the same. If the key is changed, the new key will be stored in the message.

public static BasicResult AddFeature(string token, FeatureModel parameters)

Public Shared Function AddFeature(token As String, parameters As FeatureModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`parameters`	`FeatureModel`	The parameters that the method needs.

Returns: BasicResult. The API response. Check Result and Message before using the returned data. Handled client failures are returned as a non-null result with Error. Always inspect Result before treating the response as successful.

BlockKey(string, KeyLockModel)

This method will block a specific license key to ensure that the key cannot be accessible by most of the methods in the Web API (activation, validation, optional field, and deactivation).Note, blocking the key will still allow you to access the key in Web API 3, unless otherwise stated for a given Web API 3 method. To do the reverse, please see UnblockKey(string, KeyLockModel).

public static BasicResult BlockKey(string token, KeyLockModel parameters)

Public Shared Function BlockKey(token As String, parameters As KeyLockModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token (https://app.cryptolens.io/User/AccessToken#/) with Block key permission.
`parameters`	`KeyLockModel`	The parameters that the method needs.

ChangeCustomer(string, ChangeCustomerModel)

This method will change the customer associated with a license. If the customer is not specified (for example, if CustomerId=0) or the customer with the provided ID does not exist, any customer that was previously associated with the license will be dissociated.

public static BasicResult ChangeCustomer(string token, ChangeCustomerModel parameters)

Public Shared Function ChangeCustomer(token As String, parameters As ChangeCustomerModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token (https://app.cryptolens.io/User/AccessToken#/) with Change Customer permission.
`parameters`	`ChangeCustomerModel`	The parameters that the method needs.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

ChangeNotes(string, ChangeNotesModel)

This method will change the content of the notes field of a given license key.

public static BasicResult ChangeNotes(string token, ChangeNotesModel parameters)

Public Shared Function ChangeNotes(token As String, parameters As ChangeNotesModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token (https://app.cryptolens.io/User/AccessToken#/) with Change Notes permission.
`parameters`	`ChangeNotesModel`	The parameters that the method needs.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

ChangeReseller(string, ChangeResellerModel)

This method will change the reseller of a license. If the reseller is not specified (for example, if ResellerId=0) or the reseller with the provided ID does not exist, any reseller that was previously associated with the license will be dissociated.

public static BasicResult ChangeReseller(string token, ChangeResellerModel parameters)

Public Shared Function ChangeReseller(token As String, parameters As ChangeResellerModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token (https://app.cryptolens.io/User/AccessToken#/) with Change Reseller permission.
`parameters`	`ChangeResellerModel`	The parameters that the method needs.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

CreateKey(string, CreateKeyModel)

This method will create a new license key, which is the same as GenerateKey in Web API 2.

public static CreateKeyResult CreateKey(string token, CreateKeyModel parameters)

Public Shared Function CreateKey(token As String, parameters As CreateKeyModel) As CreateKeyResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	Details such as access token and Version.
`parameters`	`CreateKeyModel`	The parameters that the method needs.

Returns: CreateKeyResult. The API response. Check Result and Message before using the returned data. Handled client failures are returned as a non-null result with Error. Always inspect Result before treating the response as successful.

CreateTrialKey(string, CreateTrialKeyModel)

Creates a trial license for the supplied product and machine code.

public static CreateKeyResult CreateTrialKey(string token, CreateTrialKeyModel parameters)

Public Shared Function CreateTrialKey(token As String, parameters As CreateTrialKeyModel) As CreateKeyResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token with the permission required by this API method.
`parameters`	`CreateTrialKeyModel`	The request model. Its properties are listed on the linked model page.

Returns: CreateKeyResult. The API response. Check Result and Message before using the returned data.

Deactivate(string, DeactivateModel)

Releases an activation for the supplied machine code.

public static BasicResult Deactivate(string token, DeactivateModel parameters)

Public Shared Function Deactivate(token As String, parameters As DeactivateModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`parameters`	`DeactivateModel`	The parameters that the method needs.

Returns: BasicResult. The API response. Check Result and Message before using the returned data. The access token needs the Deactivate permission. One access token can have both Activate and Deactivate permissions. Set DeactivateModel.Floating=true when releasing a floating activation.

ExtendLicense(string, ExtendLicenseModel)

Extends the license using the period supplied in ExtendLicenseModel.

public static BasicResult ExtendLicense(string token, ExtendLicenseModel parameters)

Public Shared Function ExtendLicense(token As String, parameters As ExtendLicenseModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token with the permission required by this API method.
`parameters`	`ExtendLicenseModel`	The request model. Its properties are listed on the linked model page.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

GetKey(string, KeyInfoModel)

Retrieves license information without registering a machine or renewing a floating seat.

public static KeyInfoResult GetKey(string token, KeyInfoModel parameters)

Public Shared Function GetKey(token As String, parameters As KeyInfoModel) As KeyInfoResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	Details such as access token and Version.
`parameters`	`KeyInfoModel`	The parameters that the method needs.

Returns: KeyInfoResult. The API response. Check Result and Message before using the returned data. Checks: The SDK does not verify the returned license signature in this call. The access token needs the GetKey permission. A successful lookup can return a blocked license. Check the fields your application relies on; retrieval success alone is not license validation.

GetKey(string, int, string, bool, string)

Retrieves license information without registering a machine or renewing a floating seat.

public static RawResponse GetKey(string token, int productId, string key, bool metadata = false, string LicenseServerUrl = null)

Public Shared Function GetKey(token As String, productId As Integer, key As String, Optional metadata As Boolean = False, Optional LicenseServerUrl As String = Nothing) As RawResponse

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token with the permission required by this API method.
`productId`	`int`	The product ID.
`key`	`string`	The license-key string.
`metadata`	`bool`	Whether to request metadata with the response.
`LicenseServerUrl`	`string`	An optional License Server base URL.

Returns: RawResponse. A signed RawResponse. Use FromResponse(string, RawResponse) to verify and decode it. Checks: The SDK does not verify the returned license signature in this call. This overload requests Sign=true, SignMethod.StringSign and model version 3. It does not acquire or renew a floating seat.

MachineLockLimit(string, MachineLockLimit)

This method will change the maximum number of machine codes that a license key can have.

public static BasicResult MachineLockLimit(string token, MachineLockLimit parameters)

Public Shared Function MachineLockLimit(token As String, parameters As MachineLockLimit) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	Details such as access token and Version.
`parameters`	`MachineLockLimit`	The parameters that the method needs.

RemoveFeature(string, FeatureModel)

Disables the selected feature, from F1 through F8, on a license.

public static BasicResult RemoveFeature(string token, FeatureModel parameters)

Public Shared Function RemoveFeature(token As String, parameters As FeatureModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token with the permission required by this API method.
`parameters`	`FeatureModel`	The request model. Its properties are listed on the linked model page.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

UnblockKey(string, KeyLockModel)

This method will unblock a specific license key to ensure that the key can be accessible by most of the methods in the Web API (activation, validation, optional field, and deactivation). To do the reverse, please see BlockKey(string, KeyLockModel).

public static BasicResult UnblockKey(string token, KeyLockModel parameters)

Public Shared Function UnblockKey(token As String, parameters As KeyLockModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	The access token (https://app.cryptolens.io/User/AccessToken#/) with Unblock key permission.
`parameters`	`KeyLockModel`	The parameters that the method needs.

FAQ

Does Activate Verify the Signature Automatically?

No. Both Activate overloads return the API response without verifying its signature. The overload returning RawResponse requests signing automatically; pass the response to LicenseKey.FromResponse with your RSA public key. With ActivateModel, set Sign=true and use the signature helpers on the returned LicenseKey.Verification of a signature is separate from your product, expiry, feature and machine checks. The Key Verification FAQ explains these checks.

Can I Activate and Deactivate With the Same Access Token?

Yes. Give the access token both the Activate permission and the Deactivate permission. Activate alone does not grant Deactivate. For a floating seat, call Deactivate with the same process ID and Floating=true. See Floating Licenses.

Does GetKey Renew a Floating Seat?

No. Use Activate to acquire or renew a floating seat, reusing the same process ID. GetKey retrieves license information without renewing the seat. maxOverdraft defaults to 0; set a positive value only when you want to allow extra seats. A failed renewal does not extend the last confirmed seat window.

.NET SDK Reference · Reviewed Source Revision

​Signed Activation Example

​Methods

​Activate(string, ActivateModel)

​Activate(string, int, string, string, bool, int, int, string, string, string)

​AddFeature(string, FeatureModel)

​BlockKey(string, KeyLockModel)

​ChangeCustomer(string, ChangeCustomerModel)

​ChangeNotes(string, ChangeNotesModel)

​ChangeReseller(string, ChangeResellerModel)

​CreateKey(string, CreateKeyModel)

​CreateTrialKey(string, CreateTrialKeyModel)

​Deactivate(string, DeactivateModel)

​ExtendLicense(string, ExtendLicenseModel)

​GetKey(string, KeyInfoModel)

​GetKey(string, int, string, bool, string)

​MachineLockLimit(string, MachineLockLimit)

​RemoveFeature(string, FeatureModel)

​UnblockKey(string, KeyLockModel)

​FAQ

Signed Activation Example

Methods

Activate(string, ActivateModel)

Activate(string, int, string, string, bool, int, int, string, string, string)

AddFeature(string, FeatureModel)

BlockKey(string, KeyLockModel)

ChangeCustomer(string, ChangeCustomerModel)

ChangeNotes(string, ChangeNotesModel)

ChangeReseller(string, ChangeResellerModel)

CreateKey(string, CreateKeyModel)

CreateTrialKey(string, CreateTrialKeyModel)

Deactivate(string, DeactivateModel)

ExtendLicense(string, ExtendLicenseModel)

GetKey(string, KeyInfoModel)

GetKey(string, int, string, bool, string)

MachineLockLimit(string, MachineLockLimit)

RemoveFeature(string, FeatureModel)

UnblockKey(string, KeyLockModel)

FAQ