Python 3: Data - Devolens (formerly Cryptolens) Documentation

Python 3 package licensing 0.54. Reviewed source revision.

from licensing.methods import Data

increment_int_value_to_key

Increase a license data object’s integer value, optionally enforcing an upper bound.

Data.increment_int_value_to_key(
    token,
    product_id,
    key,
    object_id=0,
    name='',
    int_value=0,
    enable_bound=False,
    bound=0
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`object_id`	`0`	The numeric data-object ID. Use the linked API’s rules when selecting by ID or name.
`name`	`''`	The data-object name.
`int_value`	`0`	The integer value to store, add or subtract.
`enable_bound`	`False`	Whether the API should enforce the supplied bound.
`bound`	`0`	The upper bound for an increment or the lower bound for a decrement.

Result

Returns (response_dict, ''). Read the result fields described in the linked API reference from that dictionary. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

decrement_int_value_to_key

Decrease a license data object’s integer value, optionally enforcing a lower bound.

Data.decrement_int_value_to_key(
    token,
    product_id,
    key,
    object_id=0,
    name='',
    int_value=0,
    enable_bound=False,
    bound=0
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`object_id`	`0`	The numeric data-object ID. Use the linked API’s rules when selecting by ID or name.
`name`	`''`	The data-object name.
`int_value`	`0`	The integer value to store, add or subtract.
`enable_bound`	`False`	Whether the API should enforce the supplied bound.
`bound`	`0`	The upper bound for an increment or the lower bound for a decrement.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

add_data_object_to_key

Add a data object to a license.

Data.add_data_object_to_key(
    token,
    product_id,
    key,
    name='',
    string_value='',
    int_value=0,
    check_for_duplicates=False
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`name`	`''`	The data-object name.
`string_value`	`''`	The string to store on the data object.
`int_value`	`0`	The integer value to store, add or subtract.
`check_for_duplicates`	`False`	Ask the API to check for an existing object with the same name.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

remove_data_object_to_key

Remove a data object from a license.

Data.remove_data_object_to_key(token, product_id, key, object_id=0, name='')

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`object_id`	`0`	The numeric data-object ID. Use the linked API’s rules when selecting by ID or name.
`name`	`''`	The data-object name.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

add_data_object_to_machine

Add a data object to a registered activation.

Data.add_data_object_to_machine(
    token,
    product_id,
    key,
    machine_code,
    name='',
    string_value='',
    int_value=0,
    check_for_duplicates=False
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`machine_code`	Required	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`name`	`''`	The data-object name.
`string_value`	`''`	The string to store on the data object.
`int_value`	`0`	The integer value to store, add or subtract.
`check_for_duplicates`	`False`	Ask the API to check for an existing object with the same name.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

remove_data_object_to_machine

Remove a data object from an activation.

Data.remove_data_object_to_machine(token, product_id, key, machine_code, object_id=0, name='')

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`machine_code`	Required	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`object_id`	`0`	The numeric data-object ID. Use the linked API’s rules when selecting by ID or name.
`name`	`''`	The data-object name.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

list_machine_data_objects

List an activation’s data objects.

Data.list_machine_data_objects(token, product_id, key, machine_code, name_contains='')

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`machine_code`	Required	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`name_contains`	`''`	Return data objects whose names contain this text.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

list_key_data_objects

List a license’s data objects.

Data.list_key_data_objects(token, product_id, key, name_contains='')

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	Required	The numeric product ID.
`key`	Required	The license-key string, rather than the numeric license ID.
`name_contains`	`''`	Return data objects whose names contain this text.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference. Python SDK Reference

​increment_int_value_to_key

​Parameters

​Result

​Checks

​decrement_int_value_to_key

​Parameters

​Result

​Checks

​add_data_object_to_key

​Parameters

​Result

​Checks

​remove_data_object_to_key

​Parameters

​Result

​Checks

​add_data_object_to_machine

​Parameters

​Result

​Checks

​remove_data_object_to_machine

​Parameters

​Result

​Checks

​list_machine_data_objects

​Parameters

​Result

​Checks

​list_key_data_objects

​Parameters

​Result

​Checks

increment_int_value_to_key

Parameters

Result

Checks

decrement_int_value_to_key

Parameters

Result

Checks

add_data_object_to_key

Parameters

Result

Checks

remove_data_object_to_key

Parameters

Result

Checks

add_data_object_to_machine

Parameters

Result

Checks

remove_data_object_to_machine

Parameters

Result

Checks

list_machine_data_objects

Parameters

Result

Checks

list_key_data_objects

Parameters

Result

Checks