Link
Search
✎

Services

NetLicensing exposes all available services functionality via an Application Programming Interface (API).

Using the NetLicensing REST API you can access programmatically all NetLicensing public functions and fully automate your licensing flow: from issuing and validating customer’s entitlements to managing NetLicensing assets and interface with your in-house systems, such as CRM, ERP, e-Commerce, etc. However, in most of the integration scenarios, you will need only a smaller subset of essential methods, first of all Validate licensee.

Most of the applications will use one of the existing wrapper libraries in the language of your choice, but it’s important to familiarize yourself with the underlying API HTTP methods first.

All services accept Basic authentication (vendor account) and API keys. The Role column shows the lowest API key role that may call an endpoint; “+” means that role and every higher one. Paths are relative to https://go.netlicensing.io/core/v2/rest, and every call can be tried in the API Test Center.

To access the API methods you will need a NetLicensing vendor account. If you do not have one already, sign up here.

Product Services

Products are the top-level entities that hold your product modules, licensees and discounts.

Endpoint Purpose Role
GET /product List products Licensee+
GET /product/{productNumber} Get product Licensee+
POST /product Create product Maintenance+
POST /product/{productNumber} Update product Maintenance+
DELETE /product/{productNumber} Delete product Maintenance+

Product Module Services

Product modules are the licensable parts of a product. Each module uses one licensing model.

Endpoint Purpose Role
GET /productmodule List product modules Analytics+
GET /productmodule/{productModuleNumber} Get product module Analytics+
POST /productmodule Create product module Maintenance+
POST /productmodule/{productModuleNumber} Update product module Maintenance+
DELETE /productmodule/{productModuleNumber} Delete product module Maintenance+

License Template Services

License templates define what a license grants (type, price, currency) within a product module.

Endpoint Purpose Role
GET /licensetemplate List license templates Analytics+
GET /licensetemplate/{licenseTemplateNumber} Get license template Analytics+
POST /licensetemplate Create license template Maintenance+
POST /licensetemplate/{licenseTemplateNumber} Update license template Maintenance+
DELETE /licensetemplate/{licenseTemplateNumber} Delete license template Maintenance+

Licensee Services

Licensees are your customers’ installations or users. Includes license validation and transfer.

Endpoint Purpose Role
GET /licensee List licensees Analytics+
GET /licensee/{licenseeNumber} Get one licensee Licensee+
POST /licensee Create a licensee Operation+
POST /licensee/{licenseeNumber} Update a licensee Operation+
DELETE /licensee/{licenseeNumber} Delete a licensee Operation+
POST /licensee/{licenseeNumber}/validate Validate a licensee Licensee+
POST /licensee/{licenseeNumber}/transfer Move licenses to another licensee Licensee+

License Services

Licenses are issued to a licensee from a license template.

Endpoint Purpose Role
GET /license List licenses Licensee+
GET /license/{licenseNumber} Get license Licensee+
POST /license Create license Operation+
POST /license/{licenseNumber} Update license Operation+
DELETE /license/{licenseNumber} Delete license Operation+

Bundle Services

Bundles group several license templates so they can be sold and issued together.

Endpoint Purpose Role
GET /bundle List bundles Analytics+
GET /bundle/{bundleNumber} Get bundle Analytics+
POST /bundle Create bundle Maintenance+
POST /bundle/{bundleNumber} Update bundle Maintenance+
DELETE /bundle/{bundleNumber} Delete bundle Operation+
POST /bundle/{bundleNumber}/obtain Create the bundle’s licenses for a licensee Operation+

Transaction Services

Transactions record purchases and automatic license changes.

Endpoint Purpose Role
GET /transaction List transactions Analytics+
GET /transaction/{transactionNumber} Get transaction Analytics+
POST /transaction Create transaction Admin
POST /transaction/{transactionNumber} Update transaction Admin

Token Services

Tokens grant temporary or API-key access, and create shop links for licensees.

Endpoint Purpose Role
GET /token List active tokens Admin
GET /token/{tokenNumber} Get token Admin
POST /token Create token Licensee+
DELETE /token/{tokenNumber} Delete token Admin

Payment Method Services

Payment methods available in the NetLicensing shop.

Endpoint Purpose Role
GET /paymentmethod List payment methods Admin
GET /paymentmethod/{paymentMethodNumber} Get payment method Admin
POST /paymentmethod/{paymentMethodNumber} Update payment method Admin

Utility Services

Reference data such as licensing models, license types, countries and currencies.

Endpoint Purpose Role
GET /utility/licensingModels List licensing models Analytics+
GET /utility/licenseTypes List license types Analytics+
GET /utility/countries List countries Analytics+
GET /utility/currencies List currencies Analytics+

Table of contents