Management SDK Configuration and Usage

This guide is designed to help you configure your application and start using LicenseSpring Management SDK functionality.

As you navigate through this tutorial, you'll acquire the knowledge to issue licenses and manage orders within your .NET application.

Configuration

To initialize the SDK, you must fill in your LicenseSpring Management API key. It can be found on your LicenseSpring account under Settings->Keys:

Note: API keys for licensing and management SDKs are different.

Copy this value and create the configuration as shown below:

Configuration

var configuration = new LicenseSpring.ManagementConfiguration( ManagementAPIKey );

Now you can create a ManagementService using this configuration object:

Create ManagementService

var service = new ManagementService( configuration );

Creating licenses

The following stepper shows the typical flow to create key-based licenses and create an order.

1

Generate license keys

Generate one or more license keys for the product:

GenerateLicenseKey

string productCode = "CODE";
var licenseKeys = service.LicenseService.GenerateLicenseKey( productCode );

2

Prepare LicenseDetails

Create a LicenseDetails object and set the required properties:

LicenseDetails

var license1 = new LicenseDetails();
license1.LicenseKey = licenseKeys[0];
license1.EnableMaintenancePeriod = true;
license1.MaintenanceDuration = "3m";

3

Create the order

Create an order with the license details:

CreateOrder

var keyBasedOrderId = service.OrderService.CreateOrder( new[] { license1 }, productCode );

You can also provide order info such as customer:

CreateOrder with Customer

var customer = new Customer()
{
   CompanyName = "TestCompany",
   Email = "[email protected]"
};
var orderInfo = new Order( customer );
var keyBasedOrderId = service.OrderService.CreateOrder( new[] { license1 }, productCode, orderInfo );

Managing orders

Use the returned order id to get order information and manage the order. Example: get licenses from the order.

ListOrders and ListOrderLicenses

ListOrdersRequestDto dto = new ListOrdersRequestDto()
{
   ClientOrderId = keyBasedOrderId 
};
uint count;
var ret = service.OrderService.ListOrders( dto, out count );
License[] licenses = null;
if( count == 1 && ret != null )
   licenses = service.OrderService.ListOrderLicenses( ret[0].Id );

You can also append licenses to an existing order. Example flow:

1

Generate additional keys

Generate additional license key

licenseKeys = service.LicenseService.GenerateLicenseKey( productCode );

2

Prepare new LicenseDetails

var license2 = new LicenseDetails
{
   LicenseKey = licenseKeys[0],
   Type = LicenseType.Consumption,
   MaxConsumptions = 100,
   AllowOverages = true,
   MaxOverages = 50,
   ResetConsumption = true,
   ConsumptionPeriod = ConsumptionPeriod.Weekly
};

3

Append to existing order

Pass the existing order id and customer to create/update the order with the new license:

Append license to order

orderInfo = new Order( keyBasedOrderId, customer );
keyBasedOrderId = service.OrderService.CreateOrder(  new[] { license2 }, productCode, orderInfo );

Note: one order cannot contain key-based and user-based licenses. It contains licenses for one product.

User-based licenses

Creating a user-based license is similar but you do not generate license keys. Ensure the product is user-based.

Create user-based license

string productCode = "UBCODE";
var license = new LicenseDetails
{
   EnableMaintenancePeriod = true,
   MaintenanceDuration = "7m", // 7 months
   Type = LicenseType.Consumption,
   MaxConsumptions = 10
};
var userBasedOrderId = service.OrderService.CreateOrder( new[] { license }, productCode );

To assign a user to the created license, retrieve the license via the order ID (see Managing orders) and assign the user by license ID:

AssignUser

LicenseUser user = new LicenseUser()
{
   Email = "[email protected]",
   IsManager = false
};
service.LicenseService.AssignUser( license.Id, user );