Slide background

API Reference

LicenseCloud

Universal Response

To simplify your development and reduce the number of API calls required to get the data you need, we’ve developed a master template that’s used by all of our non-administrative API calls. You can see the spec and a sample output below.

request_id

(integer) A unique ID number assigned to the request. You can view both successful and failed API calls in the admin console.

request_timestamp

(date) Time server time (in GMT) of the request.

request_status

(string) The status of the request. Will always be OK if the request was successful, or ER if there was an error with the request.

error_num

(integer) An error number associated with the request. If there were no errors, this will be a zero.

error_msg

(integer) A short description of the error.

key

(string) The license key is returned in successful responses. This will always be 20 characters.

dashed

(string). The dashed version of a license key (ex: XXXX-XXXX-XXXX-XXXX).

status

(string) The current license status. This will always be one of the following: UNUSED, ACTIVE, DISABLED, EXPIRED, or SUSPENDED.

trial

(yes/no) Indicates whether the license was configured as a trial or not.

expires

(datetime) The expiration date of the license, if one has been set. If no expiration has been set, this field will be blank.

activations_used

(integer) The number of times this license has been activated. If the license has not yet been activated, this will return zero.

max_activations

(integer) The maximum number of activations allowed for the license. If unlimited, this will be blank.

created

(date/time) The date/time the license was created.

activated

(date/time) The timestamp of the first time the license was activated.

sku

(string) The SKU of the product the license being reference is assigned to.

name

(string) The name of the product the license being referenced is assigned to.

url

(string) The URL of the product the license being referenced is assigned to. This is typically used to reference a product information or purchase page, not a download link.

supporturl

(string) The URL where customers can go to get support for the product.

supportemail

(string) An email address your customer can contact to receive product support.

current_version

(numeric string) The most current version of the product stored in LicenseCloud (regardless of the version the user is running). Represented as Major.Minor.Patch.

current_version_releasedate

(date) The date you released this version of the product the license pertains to.

current_version_filename

(string) When provided, the filename of the download (ie; myproduct.zip)

current_version_downloadurl

(string) When provided, a direct URL to a downloadable file (not a webpage with a download link). Generally this is used to automatically fetch updates.

custid

(string) An optional field where you can store the ID of the customer you’ve assigned the license to.

name

(string) An optional field where you can store the name of the customer you’ve assigned the license to.

company

(string) An optional field where you can store the company name of the customer you’ve assigned the license to.

email

(string) An optional field where you can store the e-mail address of the customer you’ve assigned the license to.

transactionid

(string) An optional field where you can store the Transaction ID for the purchase that generated the license.

price

(money) An optional field where you can store the price the customer paid for the product. This field can help provide some metrics and revenue stats for your products.

username

(string) An optional field where you can store the username of the customer you’ve assigned the license to.

custom

(string) An optional field where you can store anything you like up to 255 characters.

Sample XML

Success

Failure

Sample JSON

Success

Failure