How to Use the Web API for Licensing

What you can do:

1. Get all licenses listed in JSON format.

2. Get specific license information.

3. Get license bytes by its license key.

4. Create a new license. For this action, an Access Token is required because only users of Mobilize are allowed to perform this action. Please see the section of Get an Access Token and Create a License.

Get an access token

There are two environments where you can get an access token, one is for production and the other for development purposes (staging and development).

The recommended tool to use this API is POSTMAN.

Click on the desired environment to download it.

Import them to use the variables when you request an access token.

Request an access token

Once the desired environment is imported in POSTMAN set the parameters to get an access token:

1. Click on the Authorization tab and select OAuth 2.0

2. Set the required parameters in the Postman form using the environment variables and click on the button Get New Access Token

3. Write your user and password of Mobilize and sign in

4. Use the Token provided by the Azure Active Directory

5. Now, the token should be set as a header and you will be able to request an action from the API that requires this authorization token like create a license.

How to Create a License

To do this, postman and an access token is required.

You set the request type to POST.

Then, set the url to: https://licensing.mobilize.net/api/licenses/createlicense if it is for production or https://api-licensing-dev.azurewebsites.net/api/Licenses/CreateLicense for development or https://api-licensing-staging.azurewebsites.net/api/licenses/CreateLicense for staging.

Then, click on the body tab and set the body type as form-data.

Then, write the keys and its values for every required parameter.

The required parameters are:

• OwnerEmail: The email which will be associated with the license.

• OwnerName: The owner of the license.

• OwnerCompany: The name of the company for the license.

• Product: The name of the product, for example: "SnowConvert".

Optional Parameters:

• UnitsLimit: -1 by default. The number of lines of code that a license can convert.

• ExecutionMode: By default "Assessment". Can be changed to "Conversion".

• AvailableActivations: By default 5. Change this only if it is a special license that needs more or less than 5 activations from the server.

• ExpirationDate: no expiration date by default, set this value in the next format: yyyy/mm/dd.

The request in Postman should look like this:

Finally, just click on the send button and if nothing goes wrong the response should look like this:

DownloadLicense

GET https://api.licensing.mobilize.net/api/Licenses/DownloadLicense/{LicenseKey}

Gets the license data

Headers

[]

Get licenses

GET https://api.licensing.mobilize.net/api/Licenses/

Gets the last 100 or specific amount created licenses.

Query Parameters

GET https://api.licensing.mobilize.net/api/Licenses/{limit?}

Query Parameters

GET https://api.licensing.mobilize.net/api/Licenses/{limit?}

Query Parameters

CreateLicense

POST https://api.licensing.mobilize.net/api/licenses/createlicense/

Creates a new license

Request Body

{
    "licenseKey": "zaa11df7-be08-4f1e-81de-21db11fa7acd",
    "createdBy": "[email protected]",
    "executionMode": "Conversion",
    "ownerEmail": "[email protected]",
    "ownerName": "Alberto Espinoza",
    "ownerCompany": "Mobilize",
    "product": "SnowConvert",
    "unitsLimit": 15000,
    "availableActivations": 3,
    "timesDownloaded": 0,
    "creationDate": "2021-04-06T15:30:07.4302032Z",
    "startDate": "2021-04-06T15:30:07.4302032Z",
    "expirationDate": "9999-12-31T23:59:59.9999999"
}

Get license information

GET https://api.licensing.mobilize.net/api/licenses/getlicense/{licenseKey}

Gets the information of a specific license

Path Parameters

Create Free License

POST https://api-licensing.mobilize.net/api/licenses/CreateFreeProductLicense

This method allows for the creation of free licenses. Only some products allow for the creation of free licenses.

Request Body

{
    "ownerEmail": "[email protected]",
    "ownerName": "Luis Alonso Montero Marín",
    "ownerCompany": "Mobilize.Net",
    "unitsLimit": -1,
    "executionMode": "Conversion",
    "availableActivations": 9999,
    "timesDowloaded": 0,
    "createdBy": "Alonso Montero",
    "products": [
        "ProductC"
    ],
    "licenseKey": "7832e204-f819-42c2-9659-a5d603d6031b",
    "expirationDate": "9999-12-31T23:59:59.9999999",
    "dateIssued": "2021-09-28T17:01:27.2295001Z",
    "startDate": "2021-09-28T17:01:27.2132076Z"
}

Download Free License by Property

GET https://api-licensing.mobilize.net/api/licenses/DownloadFreeLicenseByProperty/{productName}/{propertyName}/{propertyValue}

Path Parameters