WARNING: This API has been deprecated. Use version 3.0 or newer instead.

Table of Contents

Calling conventions

All API v2 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_instance

Note: Although this method is named register_instance, it registers both an instance and its associated user.

Registers a product instance and its associated user with the server. If an instance with the same hardware information and user combination already exists, 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>,
    "guid" : <string>,
    "control_options" : {
        "session_duration" : <number>,
        "validation_grace_period" : <number>
    },
    "first_registered_at" : <string>
}

Result on failure

{
    "success" : false,
    "time" : <string>,
    "error" : <string>
}

/begin_session

Begins a new session for both a user and a product instance. The product instance is identified by its instance id. Instances must have been registered via register_instance to call this method.

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",
      ...
  },
  "duration" : <number>
}

Note: The duration parameter is optional. When present, the server may or may not respect the value, depending on the configuration of the license.

Result on success

{
    "status" : <number>,
    "time" : <string>,
    "session_key" : <string>,
    "token" : <string>,
    "features" : <string>,
    "control_options" : {
        "session_duration" : <number>,
        "validation_grace_period" : <number>
    }
}

Result on failure

{
    "success" : false,
    "time" : <string>,
    "error" : <string>
}

extend_session

Extends a session.

Data

{
    "token" : <string>,
    "duration" : <number>
}

Note: The duration parameter is optional. When present, the server may or may not respect the value, depending on the configuration of the license.

Result on success

{
    "status" : <number>,
    "time" : <string>,
    "token" : <string>,
    "control_options" : {
        "session_duration" : <number>,
        "validation_grace_period" : <number>
    }
}

Result on failure

{
    "success" : false,
    "time" : <string>,
    "error" : <string>
}

end_session

Ends a session. Ending a session is optional and is primarily used to ensure that a session cannot be extended in future calls.

Data

{
    "token" : <string>
}

Result on success

{
  "time" : <string>
}

Result on failure

Http error: 422 Unprocessable Entity