
Try the NetLicensing REST API live in your browser, with no sign-up:
https://netlicensing.io/NetLicensing-API/
NetLicensing is a cloud licensing service for software vendors. The REST API lets you validate licenses, manage
products, licensees and licensing models, and sell through a hosted shop and customer portal, from any language or
platform. The Test Center lets you call every endpoint, see the exact request and response, and copy a ready-made
curl command.
Getting started
- Open the Test Center. The public demo account is already signed in.
- Pick a card under Start here, for example Validate a license. The call opens with its input boxes ready.
- Fill in the parameters (for the demo, licensee number
cust01-desktop@local.local) and press Execute.
- Read the response and the
curl command underneath, and reuse it in your own code.
To use your own data, press Authorize and enter your vendor account or an API key
(see Authentication). Share any call with the Copy link button on its row.
Try it from the command line
Base URL: https://go.netlicensing.io/core/v2/rest
BASE=https://go.netlicensing.io/core/v2/rest
# Validate a licensee (what may this customer use?)
curl -u demo:demo -H "Accept: application/json" -X POST \
"$BASE/licensee/cust01-desktop@local.local/validate"
# List licensees, 5 per page
curl -u demo:demo -H "Accept: application/json" -G \
--data-urlencode "filter=page=0;items=5" "$BASE/licensee"
# Create a shop link for a customer
curl -u demo:demo -H "Accept: application/json" -X POST \
-d tokenType=SHOP -d licenseeNumber=cust01-desktop@local.local "$BASE/token"
# Reference data: available licensing models
curl -u demo:demo -H "Accept: application/json" "$BASE/utility/licensingModels"
Validation of a licensee whose product module uses the Floating model also needs sessionId and action
(checkOut or checkIn); other models take their own parameters, all listed in the Test Center.
What you can do
| Area |
Endpoints |
| Validate licenses |
POST /licensee/{number}/validate |
| Products and models |
/product, /productmodule, /licensetemplate, /utility/licensingModels |
| Customers and licenses |
/licensee, /license, license transfer |
| Shop and customer portal |
POST /token (SHOP and ACTION tokens), /bundle, /paymentmethod |
| Sales records |
/transaction |
| Automation |
/notification (webhooks), /reporting/{reportName} |
Authentication
HTTP Basic, in one of two ways:
- Vendor account: your NetLicensing username and password.
- API key: username
apiKey (exactly), your API key as the password. The key's role decides what it may call.
The demo account is demo / demo. It is shared and public, so do not store anything private in it.
Good to know
- Formats: requests are form-encoded (
application/x-www-form-urlencoded). Responses are XML by default; send
Accept: application/json for JSON. The Test Center asks for JSON unless you choose another media type.
- Paging and filtering: list endpoints take one
filter parameter with key=value pairs separated by ;, such
as page=0;items=50;sortorder=number;sortdirection=DESC. The default and maximum page size is 100.
- Errors: a missing entity returns
400, not 404. 401 means wrong credentials, 403 means the role may not
call that operation, and 429 means retry after the number of seconds in Retry-After.
- Custom properties: on create and update, any form field that is not a reserved property is stored on the entity
as a custom property.
Resources
Maintainers: see CONTRIBUTING.md.
Visit Labs64 NetLicensing at https://netlicensing.io