License Util function

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > SuperAdmin API > Utility >

License Util function

Activates a license code.

 

Request

Method

URL

POST

/smserver/smsadm.LicenseUtil

RAW

POST /smserver/smsadm.LicenseUtil HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{

           "command" : "activatelic",

           "license" : "B2PZ-Y4VU-Q4Z8-JRS2",

           "machineid" : "Z5ENP7AZMPRERDQHUEWBSICAKI"

}

]

Explained

"command":"activatelic"

machineid: ID of the machine where we want to activate this license code

license: the license code to be activated on the selected machine

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

{

       "command" : "activatelic",

       "license" : "THCnVz0PqqtuMTFntrSq54HAz/HSgVDzYyk7BgZ8V8vA/ksIopGbZPKrcE5W0H5FqzgGCSbN589kKDrMpW5jU8eyo4k9q7JTaZytSPvu6bWMMmoL+w96gmZyU5iGsPyS8Gb+BjJ/bxM4+9haRC7M6pyzki59x895coSx0bPAzyzqxynxH1LA+4ozync3wg9v4L8/hUVYtIGekmS3tNKZ5b9WJcUd4klvklkLZNhd5YbfNaW5KJhFoO6TTLw9SXr5A4ANK1oL0C0+edCbhF7SQ8dqaC2oZVxJcr2sudiKw07i2Dm90Wif2iMfMoZ+mNftU1b7XrmK9usr1ZUHqq5wqg==",

       "machineid" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

       "Result" : 1

   }

],"id":7721}

Explained

If result is 1 (success) then the returned object is:

 

command: our own previous command

license: the full license that was received by the activation server

machineid: ID of the machine onto which the license was activated

 

OR

 

Request

Method

URL

POST

/smserver/smsadm.LicenseUtil

RAW

POST /smserver/smsadm.login HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{

           "command" : "activatelic",

           "license" : "B2PZ-Y4VU-Q4Z8-JRS2",

           "machineid" : "Z5ENP7AZMPRERDQHUEWBSICAKI"

}

]

Explained

"command":"activatelic"

machineid: ID of the machine where we want to activate this license code

license: the license code to be activated on the selected machine

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

{

       "command" : "activatelic",

       "license" : "8NET-SAQV-3HBV-K49E",

       "machineid" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

       "ActivateLic" : 2,

       "Result" : 2,

       "prelicense" : "dHlwZT1hY3RpdmF0aW9uJmNvZGU9OE5FVC1TQVFWLTNIQlYtSzQ5RSZod2lkPUtQTiUyRmJYV2pkaEJyOEpFaCZoYXNoPUslMkZaeU1USUVLZ1JIakE2RCUyRlJEQUxwc2hkWDAlM0Q="

  }

],"id":7721}

Explained

When the online activation server cannot be reached, the "activatelic" command returns:

 

result: 2 (means that an "offline activation" is necessary)

command: our own original command

prelicense: encoded request that has to be inserted in https://lix.syncplify.me/offline.php to generate the actual license code

machineid: ID of the machine for which the license activation was requested

 

...and once we have the actual license code back from https://lix.syncplify.me/offline.php...

 

Request

Method

URL

POST

/smserver/smsadm.LicenseUtil

RAW

POST /smserver/smsadm.login HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{

           "command" : "savelictodisk",

           "rcode" : "dHlwZT1hY3RpdmF0aW9uJmNvZGU9OE5FVC1TQVFWLTNIQlYtSzQ5RSZod2lkPUtQTiUyRmJYV2pkaEJyOEpFaCZoYXNoPUslMkZaeU1USUVLZ1JIakE2RCUyRlJEQUxwc2hkWDAlM0Q=",

           "machineid" : "Z5ENP7AZMPRERDQHUEWBSICAKI"

       }

]

Explained

Used to save a license code that was produced offline by https://lix.syncplify.me/offline.php

 

command: savelictodisk

machineid: ID of the machine for which the license was created

rcode: actual license code produced by https://lix.syncplify.me/offline.php

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

{

       "Result" : 1

 }

],"id":7721}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

ResultMsg: a friendly message (success or error message) explaining what happened