BILLmanager 5 Documentation

Reselling of ISPmanager 6 licenses via API

This article describes how to use API for reselling ISPmanager 6 licenses. About reselling licenses using BILLmanager see article Reselling of ISPmanager 6 licenses via BILLmanager.

The API address of the ISPsystem billing system: https://api.ispmanager.com.

Authentification is performed with the authinfo parameter which value is authinfo=user:passwd, where user is a username in the billing system https://eu.ispmanager.com; passwd is his password.

Order license

To order a license, use the soft.order.param function with the following parameters:

  • skipbasket — do not add services to the cart and charge the client immediately. Possible values:

    • on — activate a service without putting it into the cart;
    • off — activate the service from the cart. This is the default value that you may not specify in the request;
  • ip — license IP-address.
  • licname — license name.
  • period — licensing period. Possible values:
    • period=1 — 1 month
    • period=12 — 1 year
  • autoprolong — license renewal parameter. Possible values:
    • autoprolong=1 — when a client orders a service, auto-renewal for 1 month will be set
    • autoprolong=12 - auto-renewal for 1 year
    • autoprolong=null — without auto-renewal
  • pricelist — tariff code. Possible values:
    • ISPmanager 6 Lite: pricelist=55227
    • ISPmanager 6 Pro: pricelist=55228
    • ISPmanager 6 Host: pricelist=55229
    • ISPmanager 6 Business: pricelist=55230; addon_55236=<amount>
  • addon_X — number of nodes for some types of licenses.
Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.order.param&clicked_button=finish&ip=82.156.37.16&licname=name&period=1&pricelist=55230;&addon_55236=1&autoprolong=1&sok=ok&skipbasket=on

Renew license

To renew a license use the service.prolong function which has the following parameters:

  • elid — license id.
  • period — renewal period. Possible values:
    • period=1 — 1 month
    • period=12 — 1 year
Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=service.prolong&elid=334673&period=1&sok=ok

Change license parameters

The soft.edit function allows changing the IP-address and name of the license. The new license name is passed with the licname parameter, and the new IP-address is passed with the ip parameter.

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.edit&elid=334673&licname=<new license name>&ip=<new IP-address>&sok=ok

Change license tariff

You can change the tariff using the service.changepricelist function.

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=service.changepricelist&elid=<license id>&pricelist=<tariff code>&sok=ok

Suspend license

Call the soft.suspend function to suspend a license:

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.suspend&elid=<license id>

Activate license

Call the soft.resume function to activate a license:

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=&out=xml&func=soft.resume&elid=<license id>

Check license order

Call the soft.checkip function to check if it is possible to order a license on a specific IP address.

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.checkip&pricelist=7&period=1&ip=82.145.17.16

Re-generate license key

To change the license key, call the soft.edit function. The clicked_button=newkey parameters define if the system should re-generate a new key.

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&clicked_button=newkey&elid=2512171&func=soft.edit&sok=ok

Delete license

Call the soft.delete function to delete a license:

Example of function call
https://api.ispsystem.com/manager/billmgr?authinfo=&out=xml&func=soft.delete&elid=<license code>

Viewing all ISPmanager 6 licenses

To view all ISPmanager 6 licenses, including trial ones, execute the request:

Example of the request to view the list of licenses
https://api.ispsystem.com/billmgr?authinfo=user:passwd&func=soft&out=xml&project=1
Comments