How to create and update Licenses using NetLicensing RESTful API

[r-brown]

How to create and update Licenses using NetLicensing RESTful API

[r-brown]

The NetLicensing RESTful API allows for the programmatic creation and updating of licenses. It provides full control over all existing licensing entities, enabling easy integration into various business processes, ERP, CRM, e-Commerce. The API is based on open standards, allowing access via any programming language and offering pre-built client libraries for interaction. It supports JSON or XML as its response format and standard HTTP methods like GET, PUT, POST, and DELETE. The API can be accessed using a valid NetLicensing vendor account, and the recommended way to access API services is via an 'API Key'.

[r-brown]

Create License

To assign a new license to a customer using the NetLicensing RESTful API, you can utilize the LicenseService.create() method with the essential parameters outlined below:

• licenseeNumber: the unique identifier of the customer to whom the license is being assigned
• licenseTemplateNumber: the designated template for this specific license instance
• startDate: defines the license's activation date, set to the current or later system time; use now to specify current timestamp; Note: timestamp cannot be specified to be in the past
• timeVolume: specifies the license's usage duration, represented as a numerical value
• timeVolumePeriod: indicates the time unit for the timeVolume parameter; allowed values - DAY, WEEK, MONTH, YEAR

Request example

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/xml' --header 'Authorization: Basic ZGVtbzpkZW1v' \
  -d 'licenseeNumber=IE4CIYPYU&licenseTemplateNumber=EFPHZY5FK&active=true&timeVolume=1&timeVolumePeriod=YEAR&startDate=now' \
  'https://go.netlicensing.io/core/v2/rest/license'

Response example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:netlicensing xmlns="http://www.w3.org/2000/09/xmldsig#" xmlns:ns2="http://netlicensing.labs64.com/schema/context">
    <ns2:infos />
    <ns2:items>
        <ns2:item type="License">
            <ns2:property name="number">LGCMFG69U</ns2:property>
            <ns2:property name="active">true</ns2:property>
            <ns2:property name="name">100 days</ns2:property>
            <ns2:property name="price">0.00</ns2:property>
            <ns2:property name="currency">EUR</ns2:property>
            <ns2:property name="hidden">false</ns2:property>
            <ns2:property name="licenseeNumber">IE4CIYPYU</ns2:property>
            <ns2:property name="licenseTemplateNumber">EFPHZY5FK</ns2:property>
            <ns2:property name="productModuleNumber">MNERNGP45</ns2:property>
            <ns2:property name="gracePeriod">false</ns2:property>
            <ns2:property name="timeVolumePeriod">YEAR</ns2:property>
            <ns2:property name="timeVolume">1</ns2:property>
            <ns2:property name="startDate">2024-01-11T05:39:45.986Z</ns2:property>
        </ns2:item>
    </ns2:items>
</ns2:netlicensing>

[r-brown]

Update License

To update an existing license to a customer using the NetLicensing RESTful API, you can utilize the LicenseService.update() method with the essential parameters outlined below:

Path params

• licenseNumber: the unique identifier of the license to be updated

Form params

• startDate: defines the license's activation date; Note: timestamp can be specified to be in the past as well
• timeVolume: specifies the license's usage duration, represented as a numerical value
• timeVolumePeriod: indicates the time unit for the timeVolume parameter; allowed values - DAY, WEEK, MONTH, YEAR

Request example

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/xml' --header 'Authorization: Basic ZGVtbzpkZW1v' \
  -d 'startDate=2024-01-01T00%3A00%3A00Z&timeVolume=14&timeVolumePeriod=MONTH&key1=value1' \
  'https://go.netlicensing.io/core/v2/rest/license/LGCMFG69U'

Response example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:netlicensing xmlns="http://www.w3.org/2000/09/xmldsig#" xmlns:ns2="http://netlicensing.labs64.com/schema/context">
    <ns2:infos />
    <ns2:items>
        <ns2:item type="License">
            <ns2:property name="number">LGCMFG69U</ns2:property>
            <ns2:property name="active">true</ns2:property>
            <ns2:property name="name">100 days</ns2:property>
            <ns2:property name="price">0.00</ns2:property>
            <ns2:property name="currency">EUR</ns2:property>
            <ns2:property name="hidden">false</ns2:property>
            <ns2:property name="licenseeNumber">IE4CIYPYU</ns2:property>
            <ns2:property name="licenseTemplateNumber">EFPHZY5FK</ns2:property>
            <ns2:property name="productModuleNumber">MNERNGP45</ns2:property>
            <ns2:property name="key1">value1</ns2:property>
            <ns2:property name="gracePeriod">false</ns2:property>
            <ns2:property name="timeVolumePeriod">MONTH</ns2:property>
            <ns2:property name="timeVolume">14</ns2:property>
            <ns2:property name="startDate">2024-01-01T00:00:00Z</ns2:property>
        </ns2:item>
    </ns2:items>
</ns2:netlicensing>

[r-brown]

Deactivate License

To deactivate a license, set its active parameter to false. Please note that deactivated licenses will not be included in license validation checks.

Form params

• active: this parameter determines whether the license is enabled or disabled. If set to false, the license is inactive and will not be considered during license validation checks. Licenses can be re-enabled at any time.

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/xml' --header 'Authorization: Basic ZGVtbzpkZW1v' \
  -d 'active=false' \
  'https://go.netlicensing.io/core/v2/rest/license/LGCMFG69U'

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:netlicensing xmlns="http://www.w3.org/2000/09/xmldsig#" xmlns:ns2="http://netlicensing.labs64.com/schema/context">
    <ns2:infos />
    <ns2:items>
        <ns2:item type="License">
            <ns2:property name="number">LGCMFG69U</ns2:property>
            <ns2:property name="active">false</ns2:property>
            <ns2:property name="name">100 days</ns2:property>
            <ns2:property name="price">0.00</ns2:property>
            <ns2:property name="currency">EUR</ns2:property>
            <ns2:property name="hidden">false</ns2:property>
            <ns2:property name="licenseeNumber">IE4CIYPYU</ns2:property>
            <ns2:property name="licenseTemplateNumber">EFPHZY5FK</ns2:property>
            <ns2:property name="productModuleNumber">MNERNGP45</ns2:property>
            <ns2:property name="key1">value1</ns2:property>
            <ns2:property name="gracePeriod">false</ns2:property>
            <ns2:property name="timeVolumePeriod">MONTH</ns2:property>
            <ns2:property name="timeVolume">14</ns2:property>
            <ns2:property name="startDate">2024-01-01T00:00:00Z</ns2:property>
        </ns2:item>
    </ns2:items>
</ns2:netlicensing>