WARNING: This API has been deprecated. Use version 3.0 or newer instead.
Table of Contents
Calling conventions
All API v1 endpoints accept JSON data with the following schema:
{
"key" : <string>,
"data" : <string>
}
Parameter | Description |
---|---|
key | An API key that allows the server to decrypt the data parameter value |
data | An encrypted version of the actual data supplied to the API endpoint |
/register
Registers a product instance and its associated user with the server. If an instance with the same hardware information and user combination is already registered, that instance is returned.
Data
{
"product_guid" : <string>,
"license_key" : <string>,
"ip_address" : <string>,
"cpu_id" : <string>,
"mb_serial" : <string>,
"mac_addresses" : [ <string>, <string>, ... ],
"volume_hash" : <string>,
"host_name" : <string>,
"name" : <string>,
"email" : <string>,
"user_hash" : {
"key1" : "value1",
"key2" : "value2",
...
}
}
Result on success
{
"success" : true,
"time" : <string>,
"error" : "",
"guid" : <string>
}
Result on failure
{
"success" : false,
"time" : <string>,
"error" : <string>
}
/validate
Validates that the specified product instance and user has been registered and is allowed to use the product. Also verifies that the supplied hardware and user information matches the information used when registering the user and instance.
Data
{
"product_guid" : <string>,
"license_key" : <string>,
"instance_guid" : <string>,
"ip_address" : <string>,
"cpu_id" : <string>,
"mb_serial" : <string>,
"mac_addresses" : [ <string>, <string>, ... ],
"volume_hash" : <string>,
"host_name" : <string>,
"user_hash" : {
"key1" : "value1",
"key2" : "value2",
...
}
}
Result on success
{
"status" : <number>,
"time" : <string>,
"error" : "",
"features" : <string>
}
Result on failure
{
"status" : <number>,
"time" : <string>,
"error" : <string>,
"features" : <string>
}