Keevault API Documentation

API Key Related Errors 1

Description

Verify license key

Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

API Key


Access Restrictions 1

Description

Verify license key

Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key276fac24-3dd1-429f-b8ff-3b74047e0d56

Required; License key

identifierdomain.ltd

Required; Identifier

emailemail@domain.ltd

Optional; Owner email; Only saved during Envato purchase code verification, when the purchase code is added to the license manager.


Endpoints 31

Description

Your software should consistently send accurate data. Data flagged with red flags is presumed to originate from a tampered or pirated version.

For instance, it’s imperative that your software consistently transmits a valid license key within the request. Illegitimate copies often attempt to bypass activation, resulting in requests being sent with invalid license keys.

Data collection requests should not be put behind valid activation logic; the data should be sent regardless of activation status.

Headers
KeyValueDescription
Acceptapplication/json
Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

data_typenumeric-single-value

Required; Data type, can be ‘numeric-xy-axis’, ‘numeric-single-value’, ‘text’

numeric_data_single_value50

Required if data type is ‘numeric-single-value’

product_id1

Optional; Product ID

user_identifier554dddsqfqs4dqd5qsd74q

Optional; User identifier, a distinctive string designed to identify the present software user, irrespective of their activation location or whether they possess a valid license or not.

license_key9cc2cc83-4c74-49f9-98f5-f0e1c1eb1541

Optional; License key

activation_identifier12135644

Optional; Activaton identifier

product_version1.0.1

Optional; Product verssion

data_grouptest_group

Required; Key used to group records together


Description

StartFragmeStartFragment

The ‘has_red_flags’ option allows you to retrieve records with any red flags without specifying particular ones.

Headers
KeyValueDescription
Acceptapplication/json
Query
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

data_typenumeric-single-value

Required; Data type, can be ‘numeric-xy-axis’, ‘numeric-single-value’, ‘text’

data_grouptest_group

Required; Key used to group records together

product_id100

Optional; Product ID

user_identifier554dddsqfqs4dqd5qsd74q

Optional; User identifier, unique string to identify the current software user regardless of the different activation location

license_key755aed85-409d-490b-a170-e40988c12f5c

Optional; License key

activation_identifier12135644

Optional; Activaton identifier

product_version5.2.5

Optional; Product verssion

license_key_exists1

Optional; License key exists

product_exists1

Optional; Product exists

product_version_exists1

Optional; Product version exists

is_correct_format1

Optional; Is correct format

has_red_flags0

Optional; Has redflags


Description

Verify license key

Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd

Required; License key

identifierdomain.ltd

Required; Identifier

emailemail@domain.ltd

Optional; Owner email; Only saved during Envato purchase code verification, when the purchase code is added to the license manager.


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_keyCUSTOM-91536fe6-aabf-4ac1-8a60-627830c718b0

Required; License key

identifierdomain.ltd

Required; Identifier

post_urlhttps://domain.ltd/receiver.php?example-keevault-post-url=test

Optional; Remove deactivation Post URL.


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_keybb7ffb6f-2d8e-4977-b2fa-8d43ea58aa0d

Required; License key

owner_nameTest User

Optional; Owner Name

emailemail@domain.ltd

Optional; Owner email


Headers
KeyValueDescription
Acceptapplication/json
Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd

Required; License key

identifierdomain.ltd

Required; Identifier

post_urlhttps://domain.ltd/receiver.php?example-keevault-post-url=test

Optional; Remove deactivation Post URL.

owner_emailemail@domain.ltd

Required; Owner email

owner_nameTest User

Required; Owner name


Headers
KeyValueDescription
Acceptapplication/json
Body
KeyValueDescription
api_keybd494175-4582-43dd-9c32-c58f45e2ec91

Required; API Key

product_id1

Required; License key

owner_nameTest User

Optional; Owner Name

owner_emailemail@domain.ltd
quantity7
generate0

Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key9cc2cc83-4c74-49f9-98f5-f0e1c1eb1541

Required; License key

identifierdomain.ltd

Required; Identifier


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd

Required; License key

identifierdomain.ltd

Required; Identifier


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd

Required; License key

identifierdomain.ltd

Required; Identifier


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_keys["3a343c8a-38fe-4b6e-ad77-444444","3a343c8a-38fe-4b6e-ad77-2222222","3a343c8a-38fe-4b6e-ad77-0078aaf16-333333", "9cc2cc83-4c74-49f9-98f5-f0e1c1eb1541"]

Required; JSON Array; License keys

product_id1

Required; Product ID

owner_nameTest User

Optional; Owner name

owner_emaildomain@email.ltdc

Optional; Owner email

activation_limit0

Required; Activation limit

validity0

Required; Validity in number of days

statusavailable

Required; Status, can be ‘available’, ‘assigned’, ‘reserved’, and ‘blocked’

assigned_at2024-01-08 00:00:00

Optional; Assigned at date will be used to calculate the expiration date


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key9cc2cc83-4c74-49f9-98f5-f0e1c1eb1541

Required; License key

product_id1

Required; Product ID

owner_nameTest Userx

Optional; Owner name

owner_emailemail@domain.ltd

Optional; Owner email

activation_limit0

Required; Activation limit

validity0

Required; Validity in number of days

statusassigned

Required; Status, can be ‘available’, ‘assigned’, ‘reserved’, and ‘blocked’

assigned_at2024-01-08 21:17:32

Optional; Assigned at date will be used to calculate the expiration date


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key3a343c8a-38fe-4b6e-ad77-0078aaf16xxxxeb3

Required; License key


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

sourceinternal

Required; Product source, can be ‘internal’ or ‘envato’

nameAPI Create Product

Required; Product name

descriptionAPI create product

Required; Product description

require_non_expired1

Required; Boolean, can be 1 or 0

external_reference

Optional; External refrence (item ID for Envato products)

statusactive

Required; Product status, can be ‘active’ or ‘inactive’


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id5

Required; Product ID

sourceinternal

Required; Product source, can be ‘internal’ or ‘Envato’

nameAPI Create Product

Required; Product name

descriptionTest Update

Required; Product description

require_non_expired1

Required; Boolean, can be 1 or 0

external_reference

Optional; External refrence (item ID for Envato products)

statusactive

Required; Product status, can be ‘active’ or ‘inactive’


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id5

Required; Product ID


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key3a343c8a-38fe-4b6e-ad77-2222222

Required; License key

identifierdomain.ltd

Required; Identifier

keytest-key

Required; Meta key

valuetest value

Required; Meta value


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key3a343c8a-38fe-4b6e-ad77-2222222

Required; License key

identifierdomain.ltd

Required; Identifier

keytest

Required; Meta key

valuetest value

Required; Meta value


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

license_key3a343c8a-38fe-4b6e-ad77-2222222

Required; License key

identifierdomain.ltd

Required; Identifier

keytest-key

Required; Meta key


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id1

Required; Product ID

keytest-key

Required; Meta key

valuetest value

Required; Meta value


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id4

Required; Product ID

keytest-key

Required; Meta key

valuetest value

Required; Meta value


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id4

Required; Product ID

keytest-key

Required; Meta key


Query
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key


Query
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key


Body
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

generator_id1

Required; Generator ID

quantity10

Required; Number of license keys to generate


Query
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id1

Required; Product ID

statusavailable

Required; Status, can be ‘available’, ‘assigned’, ‘reserved’, and ‘blocked’

page3

Required; Pagination page nubmer

items_per_page5

Required; Pagination records per page


Query
KeyValueDescription
api_key2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Required; API Key

product_id3

Required; Product ID


Query
KeyValueDescription
api_keybd494175-4582-43dd-9c32-c58f45e2ec91

Body
KeyValueDescription
api_keybd494175-4582-43dd-9c32-c58f45e2ec91
contract_key6dabe9fa-3512-49b4-beb5-7f837b510ec3-1234
contract_nameTest Contract
contract_informationTest information
product_id1
license_keys_quantity65
statusactive
can_get_info1
can_generate1
can_destroy1
can_destroy_all1

Body
KeyValueDescription
api_keybd494175-4582-43dd-9c32-c58f45e2ec91
contract_id8
contract_keyd375f538-9c96-11ef-b499-c87f5451677f-123456789
contract_nameTest Contract
contract_informationTest information
product_id1
license_keys_quantity65
statusactive
can_get_info1
can_generate1
can_destroy1
can_destroy_all1

Body
KeyValueDescription
api_keybd494175-4582-43dd-9c32-c58f45e2ec91
contract_id9

Available Variables 1

KeyValueType
domainhttps://demo.keevault.comstring