License Service API

License Service API

This article describes the API of the RESTful license credit system web service. A PowerFolder.com account is required to connect to this web service via BASIC authentication.

Using the License Service API

The service is reachable at the URL: https://access.powerfolder.com/service/license

At least one parameter called "action" must be passed to this URL.

Overview

Actions supported by the License Service API

Action: testConnection

For checking the availability of the service. Result: SUCCESS

Parameter

Description

Parameter

Description

action

"testConnection" must be used.


Example

https://access.powerfolder.com/service/license?action=testConnection

Action: getCredits

Retrieves the current amount of (micro) credits. Result: The number of credits available, e.g. 1337

Parameter

Description

Parameter

Description

action

"getCredits" must be used.


Example

https://access.powerfolder.com/service/license?action=getCredtis

Action: generateLicenseKey

Generates a license key. Result: The license key code as plain/text.

Parameter

Description

Parameter

Description

action

"generateLicenseKey" must be used.

email

The email address to issue the key for

orderNumber

The order number

nComputers

The number of computers the key is valid for

type

"PRO" must be used.

gbSpace

(Optional) The amount of space in gigabytes to managed local with the key

validFrom

The date the key is valid from. format: yyyy-MM-dd

validTo

The date the key is valid to. format: yyyy-MM-dd


Example

https://access.powerfolder.com/service/license?action=generateLicenseKey&email=email@example.com&orderNumber=O-PM-3232&nComputers=3&type=PRO&validFrom=2009-01-01&validTo=2010-12-31