Keevault API Documentation

API Key Related Errors 1

urlencoded

Response Examples | POST {{domain}}/api/v1/verify

Description

Verify license key

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	API Key

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492X	API Key

Access Restrictions 1

urlencoded

Blocked IP or identifier - Access denied | POST {{domain}}/api/v1/verify

Description

Verify license key

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	276fac24-3dd1-429f-b8ff-3b74047e0d56	Required; License key
identifier	domain.ltd	Required; Identifier
email	email@domain.ltd	Optional; Owner email; Only saved during Envato purchase code verification, when the purchase code is added to the license manager.

Endpoints 26

urlencoded

Send Telemetry | POST {{domain}}/api/v1/send-telemetry-date

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

Key	Value	Description
Accept	application/json

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
data_type	numeric-single-value	Required; Data type, can be ‘numeric-xy-axis’, ‘numeric-single-value’, ‘text’
numeric_data_single_value	50	Required if data type is ‘numeric-single-value’
product_id	1	Optional; Product ID
user_identifier	554dddsqfqs4dqd5qsd74q	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_key	9cc2cc83-4c74-49f9-98f5-f0e1c1eb1541	Optional; License key
activation_identifier	12135644	Optional; Activaton identifier
product_version	1.0.1	Optional; Product verssion
data_group	test_group	Required; Key used to group records together

Get Telemetry | GET {{domain}}/api/v1/get-telemetry-date

Description

StartFragmeStartFragment

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

Headers

Key	Value	Description
Accept	application/json

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
data_type	numeric-single-value	Required; Data type, can be ‘numeric-xy-axis’, ‘numeric-single-value’, ‘text’
data_group	test_group	Required; Key used to group records together
product_id	100	Optional; Product ID
user_identifier	554dddsqfqs4dqd5qsd74q	Optional; User identifier, unique string to identify the current software user regardless of the different activation location
license_key	755aed85-409d-490b-a170-e40988c12f5c	Optional; License key
activation_identifier	12135644	Optional; Activaton identifier
product_version	5.2.5	Optional; Product verssion
license_key_exists	1	Optional; License key exists
product_exists	1	Optional; Product exists
product_version_exists	1	Optional; Product version exists
is_correct_format	1	Optional; Is correct format
has_red_flags	0	Optional; Has redflags

Example Request

URL: https://keevault.local/api/v1/get-telemetry-date?api_key=2964c3c9-0b5d-4d89-b3ac-4668f30bc492&data_type=numeric-single-value&data_group=test_group&product_id=100&user_identifier=554dddsqfqs4dqd5qsd74q&license_key=755aed85-409d-490b-a170-e40988c12f5c&activation_identifier=12135644&product_version=5.2.5&license_key_exists=1&product_exists=1&product_version_exists=1&is_correct_format=1&has_red_flags=0

Headers

Key	Value	Description
Accept	application/json

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
data_type	numeric-single-value	Required; Data type, can be ‘numeric-xy-axis’, ‘numeric-single-value’, ‘text’
data_group	test_group	Required; Key used to group records together
product_id	100	Optional; Product ID
user_identifier	554dddsqfqs4dqd5qsd74q	Optional; User identifier, unique string to identify the current software user regardless of the different activation location
license_key	755aed85-409d-490b-a170-e40988c12f5c	Optional; License key
activation_identifier	12135644	Optional; Activaton identifier
product_version	5.2.5	Optional; Product verssion
license_key_exists	1	Optional; License key exists
product_exists	1	Optional; Product exists
product_version_exists	1	Optional; Product version exists
is_correct_format	1	Optional; Is correct format
has_red_flags	0	Optional; Has redflags

Example Response

Body

{ "response": { "code": 970, "message": "Telemetry data found", "data": [ { "id": 1, "user_identifier": "554dddsqfqs4dqd5qsd74q", "license_key": "755aed85-409d-490b-a170-e40988c12f5c", "activation_identifier": "12135644", "product_id": 100, "product_version": "5.2.5", "data_type": "numeric-single-value", "data_group": "test_group", "data": "50", "is_correct_format": 0, "license_key_exists": 0, "product_exists": 0, "product_version_exists": 0, "has_red_flags": 1, "created_at": "2024-02-27T01:57:24.000000Z", "updated_at": "2024-02-27T01:57:24.000000Z" }, { "id": 3, "user_identifier": "554dddsqfqs4dqd5qsd74q", "license_key": "755aed85-409d-490b-a170-e40988c12f5c", "activation_identifier": "12135644", "product_id": 100, "product_version": "5.2.5", "data_type": "numeric-single-value", "data_group": "test_group", "data": "50", "is_correct_format": 0, "license_key_exists": 0, "product_exists": 0, "product_version_exists": 0, "has_red_flags": 1, "created_at": "2024-02-27T01:58:42.000000Z", "updated_at": "2024-02-27T01:58:42.000000Z" } ], "timestamp": 1708999204 }, "response_base64": "eyJjb2RlIjo5NzAsIm1lc3NhZ2UiOiJUZWxlbWV0cnkgZGF0YSBmb3VuZCIsImRhdGEiOlt7ImlkIjoxLCJ1c2VyX2lkZW50aWZpZXIiOiI1NTRkZGRzcWZxczRkcWQ1cXNkNzRxIiwibGljZW5zZV9rZXkiOiI3NTVhZWQ4NS00MDlkLTQ5MGItYTE3MC1lNDA5ODhjMTJmNWMiLCJhY3RpdmF0aW9uX2lkZW50aWZpZXIiOiIxMjEzNTY0NCIsInByb2R1Y3RfaWQiOjEwMCwicHJvZHVjdF92ZXJzaW9uIjoiNS4yLjUiLCJkYXRhX3R5cGUiOiJudW1lcmljLXNpbmdsZS12YWx1ZSIsImRhdGFfZ3JvdXAiOiJ0ZXN0X2dyb3VwIiwiZGF0YSI6IjUwIiwiaXNfY29ycmVjdF9mb3JtYXQiOjAsImxpY2Vuc2Vfa2V5X2V4aXN0cyI6MCwicHJvZHVjdF9leGlzdHMiOjAsInByb2R1Y3RfdmVyc2lvbl9leGlzdHMiOjAsImhhc19yZWRfZmxhZ3MiOjEsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTI3VDAxOjU3OjI0LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yN1QwMTo1NzoyNC4wMDAwMDBaIn0seyJpZCI6MywidXNlcl9pZGVudGlmaWVyIjoiNTU0ZGRkc3FmcXM0ZHFkNXFzZDc0cSIsImxpY2Vuc2Vfa2V5IjoiNzU1YWVkODUtNDA5ZC00OTBiLWExNzAtZTQwOTg4YzEyZjVjIiwiYWN0aXZhdGlvbl9pZGVudGlmaWVyIjoiMTIxMzU2NDQiLCJwcm9kdWN0X2lkIjoxMDAsInByb2R1Y3RfdmVyc2lvbiI6IjUuMi41IiwiZGF0YV90eXBlIjoibnVtZXJpYy1zaW5nbGUtdmFsdWUiLCJkYXRhX2dyb3VwIjoidGVzdF9ncm91cCIsImRhdGEiOiI1MCIsImlzX2NvcnJlY3RfZm9ybWF0IjowLCJsaWNlbnNlX2tleV9leGlzdHMiOjAsInByb2R1Y3RfZXhpc3RzIjowLCJwcm9kdWN0X3ZlcnNpb25fZXhpc3RzIjowLCJoYXNfcmVkX2ZsYWdzIjoxLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yN1QwMTo1ODo0Mi4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjdUMDE6NTg6NDIuMDAwMDAwWiJ9XSwidGltZXN0YW1wIjoxNzA4OTk5MjA0fQ==", "private_key_used": "global", "signature": "a6tbieNP65lHeVCTXNBqIMHYBpajgFgcTb1dYB6ChNtwh+eq9S3uiphXCIOkheTegVod5d7fE8my5z/FTvtOWj4IUGEWsQrYxn3vlahxLkWlUdxJD8xH+U1+/5qijibQcueWl6Tlpvi0yTBhoEeQ1ZQ6W3zE+D2QHoyhzzCtFraFRYYl7BSqzMcujtz8Dy/tftOItbJRk1LdCfWt48az/MKd5NcKW6nU819u09KoD0ddgxxK3KMueV1Ruv11091Eqba1oYQvtrGWGZFh30/h2xHjKZLq1f7/Ln+vnxEYlSHXTFdBDBgJqdXi44OVUftkZt3AL/GmART95o+/CC3EZA==" }

Code:

200

urlencoded

Verify License Key | POST {{domain}}/api/v1/verify

Description

Verify license key

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd	Required; License key
identifier	domain.ltd	Required; Identifier
email	email@domain.ltd	Optional; Owner email; Only saved during Envato purchase code verification, when the purchase code is added to the license manager.

urlencoded

Activate License Key | POST {{domain}}/api/v1/activate

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	CUSTOM-91536fe6-aabf-4ac1-8a60-627830c718b0	Required; License key
identifier	domain.ltd	Required; Identifier
post_url	https://domain.ltd/receiver.php?example-keevault-post-url=test	Optional; Remove deactivation Post URL.

urlencoded

Assign License Key | POST {{domain}}/api/v1/assign-license-key

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	bb7ffb6f-2d8e-4977-b2fa-8d43ea58aa0d	Required; License key
owner_name	Test User	Optional; Owner Name
email	email@domain.ltd	Optional; Owner email

urlencoded

Assign And Activate License Key | POST {{domain}}/api/v1/assign-and-activate-license-key

Headers

Key	Value	Description
Accept	application/json

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd	Required; License key
identifier	domain.ltd	Required; Identifier
post_url	https://domain.ltd/receiver.php?example-keevault-post-url=test	Optional; Remove deactivation Post URL.
owner_email	email@domain.ltd	Required; Owner email
owner_name	Test User	Required; Owner name

urlencoded

Deactivate License Key | POST {{domain}}/api/v1/deactivate

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	9cc2cc83-4c74-49f9-98f5-f0e1c1eb1541	Required; License key
identifier	domain.ltd	Required; Identifier

urlencoded

Get License Key Details | POST {{domain}}/api/v1/get-license-key-details

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd	Required; License key
identifier	domain.ltd	Required; Identifier

Example Request

URL: https://keevault.local/api/v1/get-license-key-details

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	65a90cff-8da2-4820-9c9a-a13a041891fd	Required; License key
identifier	domain.ltd	Required; Identifier

Example Response

Body

{ "response": { "code": 500, "message": "Active license key found", "licenseKey": { "id": 1034773, "license_key": "3a343c8a-38fe-4b6e-ad77-2222222", "owner_name": "Test User", "owner_email": "email@domain.ltd", "activation_limit": 0, "validity": 0, "assigned_at": "2024-02-27 03:05:31", "meta_data": [ { "key": "test-key", "value": "test value y" }, { "key": "test-key-2", "value": "test value y2" } ], "expires_at": false }, "product": { "id": 1, "external_reference": "", "source": "internal", "name": "Test Product", "post_url": "", "description": "Test product that has it's own private key", "meta_data": [ { "key": "test-key", "value": "test value x" }, { "key": "test-key-2", "value": "test value x2" } ] }, "timestamp": 1709534415 }, "response_base64": "eyJjb2RlIjo1MDAsIm1lc3NhZ2UiOiJBY3RpdmUgbGljZW5zZSBrZXkgZm91bmQiLCJsaWNlbnNlS2V5Ijp7ImlkIjoxMDM0NzczLCJsaWNlbnNlX2tleSI6IjNhMzQzYzhhLTM4ZmUtNGI2ZS1hZDc3LTIyMjIyMjIiLCJvd25lcl9uYW1lIjoiVGVzdCBVc2VyIiwib3duZXJfZW1haWwiOiJlbWFpbEBkb21haW4ubHRkIiwiYWN0aXZhdGlvbl9saW1pdCI6MCwidmFsaWRpdHkiOjAsImFzc2lnbmVkX2F0IjoiMjAyNC0wMi0yNyAwMzowNTozMSIsIm1ldGFfZGF0YSI6W3sia2V5IjoidGVzdC1rZXkiLCJ2YWx1ZSI6InRlc3QgdmFsdWUgeSJ9LHsia2V5IjoidGVzdC1rZXktMiIsInZhbHVlIjoidGVzdCB2YWx1ZSB5MiJ9XSwiZXhwaXJlc19hdCI6ZmFsc2V9LCJwcm9kdWN0Ijp7ImlkIjoxLCJleHRlcm5hbF9yZWZlcmVuY2UiOiIiLCJzb3VyY2UiOiJpbnRlcm5hbCIsIm5hbWUiOiJUZXN0IFByb2R1Y3QiLCJwb3N0X3VybCI6IiIsImRlc2NyaXB0aW9uIjoiVGVzdCBwcm9kdWN0IHRoYXQgaGFzIGl0J3Mgb3duIHByaXZhdGUga2V5IiwibWV0YV9kYXRhIjpbeyJrZXkiOiJ0ZXN0LWtleSIsInZhbHVlIjoidGVzdCB2YWx1ZSB4In0seyJrZXkiOiJ0ZXN0LWtleS0yIiwidmFsdWUiOiJ0ZXN0IHZhbHVlIHgyIn1dfSwidGltZXN0YW1wIjoxNzA5NTM0NDE1fQ==", "private_key_used": "product", "signature": "rKceBFV5ySsPy9wKs53c2e35/vJedvf7tjrT7oP/CtkfJbLMGwjA50AV7t5eA5UDFjT77FvU4vDEJUpt8Adq5sogNUkG9S9NH0mYNeDdW/JwYL5cWCFpv3972EopMYiFHNavThl4rTgbtby2gpGRBrBMDbXr4AVLc3Hn5kXWleQ3IFgPFu0I1PNDw+L2TTeVxuY7zq3BvrwuDEv5WXgdW8tbvOs3tyKakU3YLAJKsir0Hk+Ez0p6bKKO3Xwfaed5A3vj/eQXTQJYOzhr9+bDBhIYHScOC31aTfBtg30h/fimI+a9m9MwqxiaD/IxnyYYS5o84M0VKvEBKIYzi/Rc0w==" }

Code:

200

urlencoded

Access Downloadables | POST {{domain}}/api/v1/access-downloadables

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	19d4c2a0-b2ee-47a9-9fa7-f8befcc142fd	Required; License key
identifier	domain.ltd	Required; Identifier

Example Request

URL: https://keevault.local/api/v1/access-downloadables

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
license_key	65a90cff-8da2-4820-9c9a-a13a041891fd	Required; License key
identifier	domain.ltd	Required; Identifier

Example Response

Body

{ "response": { "code": 600, "message": "Downloads", "downloadables": [ { "id": 2, "product_id": 1, "numeric_version": 102, "version": "1.0.2", "update_summary": "Bugfixes", "changelog": "Bugfixes", "published": 1, "release_date": "2024-02-27 00:00:00", "download_counter": 0, "url": "https://keevault.local/api/v1/download/2964c3c9-0b5d-4d89-b3ac-4668f30bc492/65a90cff-8da2-4820-9c9a-a13a041891fd/ZG9tYWluLmx0ZA%3D%3D/102" }, { "id": 1, "product_id": 1, "numeric_version": 101, "version": "1.0.1", "update_summary": "Bugfixes", "changelog": "Minor bug fixes", "published": 1, "release_date": "2024-02-27 00:00:00", "download_counter": 0, "url": "https://keevault.local/api/v1/download/2964c3c9-0b5d-4d89-b3ac-4668f30bc492/65a90cff-8da2-4820-9c9a-a13a041891fd/ZG9tYWluLmx0ZA%3D%3D/101" } ], "timestamp": 1709001214 }, "response_base64": "eyJjb2RlIjo2MDAsIm1lc3NhZ2UiOiJMaWNlbnNlIGtleSBmb3VuZCIsImRvd25sb2FkYWJsZXMiOlt7ImlkIjoyLCJwcm9kdWN0X2lkIjoxLCJudW1lcmljX3ZlcnNpb24iOjEwMiwidmVyc2lvbiI6IjEuMC4yIiwidXBkYXRlX3N1bW1hcnkiOiJCdWdmaXhlcyIsImNoYW5nZWxvZyI6IkJ1Z2ZpeGVzIiwicHVibGlzaGVkIjoxLCJyZWxlYXNlX2RhdGUiOiIyMDI0LTAyLTI3IDAwOjAwOjAwIiwiZG93bmxvYWRfY291bnRlciI6MCwidXJsIjoiaHR0cHM6XC9cL2tlZXZhdWx0LmxvY2FsXC9hcGlcL3YxXC9kb3dubG9hZFwvMjk2NGMzYzktMGI1ZC00ZDg5LWIzYWMtNDY2OGYzMGJjNDkyXC82NWE5MGNmZi04ZGEyLTQ4MjAtOWM5YS1hMTNhMDQxODkxZmRcL1pHOXRZV2x1TG14MFpBJTNEJTNEXC8xMDIifSx7ImlkIjoxLCJwcm9kdWN0X2lkIjoxLCJudW1lcmljX3ZlcnNpb24iOjEwMSwidmVyc2lvbiI6IjEuMC4xIiwidXBkYXRlX3N1bW1hcnkiOiJCdWdmaXhlcyIsImNoYW5nZWxvZyI6Ik1pbm9yIGJ1ZyBmaXhlcyIsInB1Ymxpc2hlZCI6MSwicmVsZWFzZV9kYXRlIjoiMjAyNC0wMi0yNyAwMDowMDowMCIsImRvd25sb2FkX2NvdW50ZXIiOjAsInVybCI6Imh0dHBzOlwvXC9rZWV2YXVsdC5sb2NhbFwvYXBpXC92MVwvZG93bmxvYWRcLzI5NjRjM2M5LTBiNWQtNGQ4OS1iM2FjLTQ2NjhmMzBiYzQ5MlwvNjVhOTBjZmYtOGRhMi00ODIwLTljOWEtYTEzYTA0MTg5MWZkXC9aRzl0WVdsdUxteDBaQSUzRCUzRFwvMTAxIn1dLCJ0aW1lc3RhbXAiOjE3MDkwMDEyMTR9", "private_key_used": "product", "signature": "OnKB1KO7hlPVHK500ykyucQjBPmef2W1vTLaUAXh/AzCI6XNwK7TbxQj1lspdbovaeXzonQsOrL/Lx9jyT0s9uz8dC7P00dSOPM1zj0AnPOtn04BtnZKkH4VLT+0/xvYtsn0GMQ6slsL3jhruxb59G7Bv4Gq3zEG6dnCRcQDnH7SxAYNwXUXLglZ2CggCe/5pk1JCF5hijRnQjELJ5Uhr2Ut1m/7FjTxbNN8TXlTgDe0nbtJ+kUOCaPrvH7M+vbTJf2gy6/bc1aQDmZV4S0rAk/VEaBrVAcTXswJJ3xB/3JN+1fNWBpPAtcFqUL3dyNp56/fcpDVi4yEzwzYWsDBgQ==" }

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
product_id	4	Required; Product ID
key	test-key	Required; Meta key

Get All Products | GET {{domain}}/api/v1/get-all-products

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key

Example Request

URL: https://keevault.local/api/v1/get-all-products?api_key=2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key

Example Response

Body

{ "response": { "code": 810, "message": "All products", "products": [ { "id": 1, "external_reference": "", "source": "internal", "name": "Test Product", "post_url": "", "description": "Test product that has it's own private key", "status": "active", "require_non_expired": 0, "created_at": "2024-02-24T16:57:17.000000Z", "updated_at": "2024-02-24T18:36:00.000000Z", "meta_data": [ { "key": "test-key", "value": "test value x" }, { "key": "test-key-2", "value": "test value x2" } ] }, { "id": 2, "external_reference": "", "source": "internal", "name": " Deski Support", "post_url": "", "description": " WordPress HelpDesk & Support Ticketing Plugin", "status": "active", "require_non_expired": 0, "created_at": "2024-02-24T20:50:57.000000Z", "updated_at": "2024-02-24T20:50:57.000000Z", "meta_data": [] }, { "id": 3, "external_reference": "", "source": "internal", "name": "Example Product", "post_url": "", "description": "Inactive product example", "status": "active", "require_non_expired": 0, "created_at": "2024-02-24T20:51:47.000000Z", "updated_at": "2024-03-03T08:47:49.000000Z", "meta_data": [] }, { "id": 4, "external_reference": "", "source": "internal", "name": "Nanosoft Doors", "post_url": "", "description": "Desktop operation system", "status": "active", "require_non_expired": 1, "created_at": "2024-02-24T20:53:41.000000Z", "updated_at": "2024-02-24T20:53:41.000000Z", "meta_data": [] } ], "timestamp": 1709534400 }, "response_base64": "eyJjb2RlIjo4MTAsIm1lc3NhZ2UiOiJBbGwgcHJvZHVjdHMiLCJwcm9kdWN0cyI6W3siaWQiOjEsImV4dGVybmFsX3JlZmVyZW5jZSI6IiIsInNvdXJjZSI6ImludGVybmFsIiwibmFtZSI6IlRlc3QgUHJvZHVjdCIsInBvc3RfdXJsIjoiIiwiZGVzY3JpcHRpb24iOiJUZXN0IHByb2R1Y3QgdGhhdCBoYXMgaXQncyBvd24gcHJpdmF0ZSBrZXkiLCJzdGF0dXMiOiJhY3RpdmUiLCJyZXF1aXJlX25vbl9leHBpcmVkIjowLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQxNjo1NzoxNy4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMTg6MzY6MDAuMDAwMDAwWiIsIm1ldGFfZGF0YSI6W3sia2V5IjoidGVzdC1rZXkiLCJ2YWx1ZSI6InRlc3QgdmFsdWUgeCJ9LHsia2V5IjoidGVzdC1rZXktMiIsInZhbHVlIjoidGVzdCB2YWx1ZSB4MiJ9XX0seyJpZCI6MiwiZXh0ZXJuYWxfcmVmZXJlbmNlIjoiIiwic291cmNlIjoiaW50ZXJuYWwiLCJuYW1lIjoiIERlc2tpIFN1cHBvcnQiLCJwb3N0X3VybCI6IiIsImRlc2NyaXB0aW9uIjoiIFdvcmRQcmVzcyBIZWxwRGVzayAmIFN1cHBvcnQgVGlja2V0aW5nIFBsdWdpbiIsInN0YXR1cyI6ImFjdGl2ZSIsInJlcXVpcmVfbm9uX2V4cGlyZWQiOjAsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIwOjUwOjU3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMDo1MDo1Ny4wMDAwMDBaIiwibWV0YV9kYXRhIjpbXX0seyJpZCI6MywiZXh0ZXJuYWxfcmVmZXJlbmNlIjoiIiwic291cmNlIjoiaW50ZXJuYWwiLCJuYW1lIjoiRXhhbXBsZSBQcm9kdWN0IiwicG9zdF91cmwiOiIiLCJkZXNjcmlwdGlvbiI6IkluYWN0aXZlIHByb2R1Y3QgZXhhbXBsZSIsInN0YXR1cyI6ImFjdGl2ZSIsInJlcXVpcmVfbm9uX2V4cGlyZWQiOjAsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIwOjUxOjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMy0wM1QwODo0Nzo0OS4wMDAwMDBaIiwibWV0YV9kYXRhIjpbXX0seyJpZCI6NCwiZXh0ZXJuYWxfcmVmZXJlbmNlIjoiIiwic291cmNlIjoiaW50ZXJuYWwiLCJuYW1lIjoiTmFub3NvZnQgRG9vcnMiLCJwb3N0X3VybCI6IiIsImRlc2NyaXB0aW9uIjoiRGVza3RvcCBvcGVyYXRpb24gc3lzdGVtIiwic3RhdHVzIjoiYWN0aXZlIiwicmVxdWlyZV9ub25fZXhwaXJlZCI6MSwiY3JlYXRlZF9hdCI6IjIwMjQtMDItMjRUMjA6NTM6NDEuMDAwMDAwWiIsInVwZGF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIwOjUzOjQxLjAwMDAwMFoiLCJtZXRhX2RhdGEiOltdfV0sInRpbWVzdGFtcCI6MTcwOTUzNDQwMH0=", "private_key_used": "global", "signature": "UtcMnR8u/IuJs8Icn13L/g8ABS5pwn2mxGwJ32+8vJ8CxNhYciK2CU+eD46KvC9AE1dvCdEZTGozWQVyILvlSRtzru6oqb7jzHr6VusDEn4EFtdYuZAGXcGZ1LZRwSxnBHvLAmRDG9uvpJbbIc6gVsQCW9GR+8EMKzx0V2M6JZCzg2H3X0K49vi+w+HkMvS+ecPi2B+C3BQv1jBoD0bU5sQbFO9fyfKDDOp0eoI6UI6jIgOcaRc0EjKvbdSKxt0+sIRummEyds/VJbhZqb9XFEN3yy79c4u3IxiLxebmdq1IW02v2YXp2iVraa3eZVuqSvYSgRIAc/H2ltbrjq/QaA==" }

Code:

200

Get All Generators | GET {{domain}}/api/v1/get-all-generators

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key

Example Request

URL: https://keevault.local/api/v1/get-all-generators?api_key=2964c3c9-0b5d-4d89-b3ac-4668f30bc492

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key

Example Response

Body

{ "response": { "code": 820, "message": "All generators", "products": [ { "id": 1, "product_id": 1, "method": "uuid", "prefix": "", "suffix": "", "function_name": "", "number_of_chunks": 4, "chunk_length": 4, "activation_limit": 1, "validity": 365, "status": 1, "charset": "0123456789ABCDEF", "created_at": "2024-02-24T20:54:16.000000Z", "updated_at": "2024-02-24T20:54:16.000000Z" }, { "id": 2, "product_id": 2, "method": "chunk-system", "prefix": "", "suffix": "", "function_name": "", "number_of_chunks": 4, "chunk_length": 4, "activation_limit": 1, "validity": 365, "status": 0, "charset": "0123456789ABCDEF", "created_at": "2024-02-24T20:54:28.000000Z", "updated_at": "2024-02-24T20:54:28.000000Z" }, { "id": 3, "product_id": 4, "method": "custom", "prefix": "", "suffix": "", "function_name": "testFunction", "number_of_chunks": 4, "chunk_length": 4, "activation_limit": 1, "validity": 0, "status": 0, "charset": "0123456789ABCDEF", "created_at": "2024-02-24T20:55:28.000000Z", "updated_at": "2024-02-24T20:55:28.000000Z" } ], "timestamp": 1709003381 }, "response_base64": "eyJjb2RlIjo4MjAsIm1lc3NhZ2UiOiJBbGwgZ2VuZXJhdG9ycyIsInByb2R1Y3RzIjpbeyJpZCI6MSwicHJvZHVjdF9pZCI6MSwibWV0aG9kIjoidXVpZCIsInByZWZpeCI6IiIsInN1ZmZpeCI6IiIsImZ1bmN0aW9uX25hbWUiOiIiLCJudW1iZXJfb2ZfY2h1bmtzIjo0LCJjaHVua19sZW5ndGgiOjQsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsInN0YXR1cyI6MSwiY2hhcnNldCI6IjAxMjM0NTY3ODlBQkNERUYiLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMDo1NDoxNi4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMjA6NTQ6MTYuMDAwMDAwWiJ9LHsiaWQiOjIsInByb2R1Y3RfaWQiOjIsIm1ldGhvZCI6ImNodW5rLXN5c3RlbSIsInByZWZpeCI6IiIsInN1ZmZpeCI6IiIsImZ1bmN0aW9uX25hbWUiOiIiLCJudW1iZXJfb2ZfY2h1bmtzIjo0LCJjaHVua19sZW5ndGgiOjQsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsInN0YXR1cyI6MCwiY2hhcnNldCI6IjAxMjM0NTY3ODlBQkNERUYiLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMDo1NDoyOC4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMjA6NTQ6MjguMDAwMDAwWiJ9LHsiaWQiOjMsInByb2R1Y3RfaWQiOjQsIm1ldGhvZCI6ImN1c3RvbSIsInByZWZpeCI6IiIsInN1ZmZpeCI6IiIsImZ1bmN0aW9uX25hbWUiOiJ0ZXN0RnVuY3Rpb24iLCJudW1iZXJfb2ZfY2h1bmtzIjo0LCJjaHVua19sZW5ndGgiOjQsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjowLCJzdGF0dXMiOjAsImNoYXJzZXQiOiIwMTIzNDU2Nzg5QUJDREVGIiwiY3JlYXRlZF9hdCI6IjIwMjQtMDItMjRUMjA6NTU6MjguMDAwMDAwWiIsInVwZGF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIwOjU1OjI4LjAwMDAwMFoifV0sInRpbWVzdGFtcCI6MTcwOTAwMzM4MX0=", "private_key_used": "global", "signature": "k/5qRBe9iHPFfO1Y3G1Qo9tHGqHc5Se4pG3aVnNPU5lAuROMEl16dJzMcLZ9Plwfx/SZ+rBIT0d8ngVN+QWwIqVkkCyGTyrvjXKI7vlzaSYX7GFMe703e2yJQadOSv2owvjpCY0Nwrqfgfms3GZM7Bt22MMyv/CljxN0YZMly60I874+jApcX9TqDI9zLUndrE4oKcscOyQyjmGRG5E1NYXXv//z9nQQbygtUD+NhPzMRKuWa7a01H+YzDLcFGx6d2BcpBpcrB2Z5Ewu8f7MnH9m8EUu7z+nWERBLldSLDTtCIGSWyb8QGkOIKKph1ui4scZMFwDBpKRKshlzH4BYw==" }

Code:

200

urlencoded

Generate | POST {{domain}}/api/v1/generate

Body

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
generator_id	1	Required; Generator ID
quantity	10	Required; Number of license keys to generate

Get License Keys | GET {{domain}}/api/v1/get-license-keys

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
product_id	1	Required; Product ID
status	available	Required; Status, can be ‘available’, ‘assigned’, ‘reserved’, and ‘blocked’
page	3	Required; Pagination page nubmer
items_per_page	5	Required; Pagination records per page

Example Request

URL: https://keevault.local/api/v1/get-license-keys?api_key=2964c3c9-0b5d-4d89-b3ac-4668f30bc492&product_id=1&status=available&page=3&items_per_page=5

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
product_id	1	Required; Product ID
status	available	Required; Status, can be ‘available’, ‘assigned’, ‘reserved’, and ‘blocked’
page	3	Required; Pagination page nubmer
items_per_page	5	Required; Pagination records per page

Example Response

Body

{ "response": { "code": 730, "message": "License keys", "license_keys": [ { "id": 944516, "product_id": 1, "license_key": "2f09f12d-7040-4bc6-a506-23f372d09a25", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944517, "product_id": 1, "license_key": "85940963-97bd-4ba7-9f60-5d431662079a", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944518, "product_id": 1, "license_key": "270d342e-8e95-4607-b932-7d79be520976", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944519, "product_id": 1, "license_key": "880a351d-c100-409a-bcde-7bc6cb97c8c1", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944520, "product_id": 1, "license_key": "1416b187-2b55-4bc7-b0c8-9df2fba9d8cd", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944521, "product_id": 1, "license_key": "24d16e40-c343-40fb-9fbf-3555e0543ae1", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944522, "product_id": 1, "license_key": "dc2d70c5-85c7-4838-ac20-cefb9d9e6e7f", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944523, "product_id": 1, "license_key": "4c16b3ad-dd0a-45bd-9072-4d613577a112", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944524, "product_id": 1, "license_key": "9e003e21-dcbe-475e-82ad-238305c723a0", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" }, { "id": 944525, "product_id": 1, "license_key": "0b9c5c36-813f-4f4c-9cf3-ce2d291089f8", "owner_name": null, "owner_email": null, "activation_limit": 1, "validity": 365, "assigned_at": null, "status": "available", "created_at": "2024-02-24T21:21:24.000000Z", "updated_at": "2024-02-24T21:21:24.000000Z" } ], "timestamp": 1709003445 }, "response_base64": "eyJjb2RlIjo3MzAsIm1lc3NhZ2UiOiJMaWNlbnNlIGtleXMiLCJsaWNlbnNlX2tleXMiOlt7ImlkIjo5NDQ1MTYsInByb2R1Y3RfaWQiOjEsImxpY2Vuc2Vfa2V5IjoiMmYwOWYxMmQtNzA0MC00YmM2LWE1MDYtMjNmMzcyZDA5YTI1Iiwib3duZXJfbmFtZSI6bnVsbCwib3duZXJfZW1haWwiOm51bGwsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsImFzc2lnbmVkX2F0IjpudWxsLCJzdGF0dXMiOiJhdmFpbGFibGUiLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiJ9LHsiaWQiOjk0NDUxNywicHJvZHVjdF9pZCI6MSwibGljZW5zZV9rZXkiOiI4NTk0MDk2My05N2JkLTRiYTctOWY2MC01ZDQzMTY2MjA3OWEiLCJvd25lcl9uYW1lIjpudWxsLCJvd25lcl9lbWFpbCI6bnVsbCwiYWN0aXZhdGlvbl9saW1pdCI6MSwidmFsaWRpdHkiOjM2NSwiYXNzaWduZWRfYXQiOm51bGwsInN0YXR1cyI6ImF2YWlsYWJsZSIsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIxOjIxOjI0LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIn0seyJpZCI6OTQ0NTE4LCJwcm9kdWN0X2lkIjoxLCJsaWNlbnNlX2tleSI6IjI3MGQzNDJlLThlOTUtNDYwNy1iOTMyLTdkNzliZTUyMDk3NiIsIm93bmVyX25hbWUiOm51bGwsIm93bmVyX2VtYWlsIjpudWxsLCJhY3RpdmF0aW9uX2xpbWl0IjoxLCJ2YWxpZGl0eSI6MzY1LCJhc3NpZ25lZF9hdCI6bnVsbCwic3RhdHVzIjoiYXZhaWxhYmxlIiwiY3JlYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiIsInVwZGF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIxOjIxOjI0LjAwMDAwMFoifSx7ImlkIjo5NDQ1MTksInByb2R1Y3RfaWQiOjEsImxpY2Vuc2Vfa2V5IjoiODgwYTM1MWQtYzEwMC00MDlhLWJjZGUtN2JjNmNiOTdjOGMxIiwib3duZXJfbmFtZSI6bnVsbCwib3duZXJfZW1haWwiOm51bGwsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsImFzc2lnbmVkX2F0IjpudWxsLCJzdGF0dXMiOiJhdmFpbGFibGUiLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiJ9LHsiaWQiOjk0NDUyMCwicHJvZHVjdF9pZCI6MSwibGljZW5zZV9rZXkiOiIxNDE2YjE4Ny0yYjU1LTRiYzctYjBjOC05ZGYyZmJhOWQ4Y2QiLCJvd25lcl9uYW1lIjpudWxsLCJvd25lcl9lbWFpbCI6bnVsbCwiYWN0aXZhdGlvbl9saW1pdCI6MSwidmFsaWRpdHkiOjM2NSwiYXNzaWduZWRfYXQiOm51bGwsInN0YXR1cyI6ImF2YWlsYWJsZSIsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIxOjIxOjI0LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIn0seyJpZCI6OTQ0NTIxLCJwcm9kdWN0X2lkIjoxLCJsaWNlbnNlX2tleSI6IjI0ZDE2ZTQwLWMzNDMtNDBmYi05ZmJmLTM1NTVlMDU0M2FlMSIsIm93bmVyX25hbWUiOm51bGwsIm93bmVyX2VtYWlsIjpudWxsLCJhY3RpdmF0aW9uX2xpbWl0IjoxLCJ2YWxpZGl0eSI6MzY1LCJhc3NpZ25lZF9hdCI6bnVsbCwic3RhdHVzIjoiYXZhaWxhYmxlIiwiY3JlYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiIsInVwZGF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIxOjIxOjI0LjAwMDAwMFoifSx7ImlkIjo5NDQ1MjIsInByb2R1Y3RfaWQiOjEsImxpY2Vuc2Vfa2V5IjoiZGMyZDcwYzUtODVjNy00ODM4LWFjMjAtY2VmYjlkOWU2ZTdmIiwib3duZXJfbmFtZSI6bnVsbCwib3duZXJfZW1haWwiOm51bGwsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsImFzc2lnbmVkX2F0IjpudWxsLCJzdGF0dXMiOiJhdmFpbGFibGUiLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiJ9LHsiaWQiOjk0NDUyMywicHJvZHVjdF9pZCI6MSwibGljZW5zZV9rZXkiOiI0YzE2YjNhZC1kZDBhLTQ1YmQtOTA3Mi00ZDYxMzU3N2ExMTIiLCJvd25lcl9uYW1lIjpudWxsLCJvd25lcl9lbWFpbCI6bnVsbCwiYWN0aXZhdGlvbl9saW1pdCI6MSwidmFsaWRpdHkiOjM2NSwiYXNzaWduZWRfYXQiOm51bGwsInN0YXR1cyI6ImF2YWlsYWJsZSIsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIxOjIxOjI0LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIn0seyJpZCI6OTQ0NTI0LCJwcm9kdWN0X2lkIjoxLCJsaWNlbnNlX2tleSI6IjllMDAzZTIxLWRjYmUtNDc1ZS04MmFkLTIzODMwNWM3MjNhMCIsIm93bmVyX25hbWUiOm51bGwsIm93bmVyX2VtYWlsIjpudWxsLCJhY3RpdmF0aW9uX2xpbWl0IjoxLCJ2YWxpZGl0eSI6MzY1LCJhc3NpZ25lZF9hdCI6bnVsbCwic3RhdHVzIjoiYXZhaWxhYmxlIiwiY3JlYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiIsInVwZGF0ZWRfYXQiOiIyMDI0LTAyLTI0VDIxOjIxOjI0LjAwMDAwMFoifSx7ImlkIjo5NDQ1MjUsInByb2R1Y3RfaWQiOjEsImxpY2Vuc2Vfa2V5IjoiMGI5YzVjMzYtODEzZi00ZjRjLTljZjMtY2UyZDI5MTA4OWY4Iiwib3duZXJfbmFtZSI6bnVsbCwib3duZXJfZW1haWwiOm51bGwsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsImFzc2lnbmVkX2F0IjpudWxsLCJzdGF0dXMiOiJhdmFpbGFibGUiLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yNFQyMToyMToyNC4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjRUMjE6MjE6MjQuMDAwMDAwWiJ9XSwidGltZXN0YW1wIjoxNzA5MDAzNDQ1fQ==", "private_key_used": "global", "signature": "FnpuID8U+2gGke5Bbxw44QDHhiohWCH+GJViCpA22OrHclbRo/K4N4V8gpUBik8zcnQV3mYjaNVOLcNj46Aqh5cPg2Bd0knw71D5JzgZa+xDGXaYY1bywIGUHCS2Irj0ptAqh6CK+nMU0Gp9SIOD2rukjOGcFWQQFtsdY0JDiogsFEOrRHXWj+QLuEPGAx5Tf5UMLd5fqf+Ia3F/8mAJ59g9W5mh8WBfIaZAt8sO0MnTtVvv6C2l4h9kesK7u2mL9qI88cUTyW9rVBl8UwnswudbBL/vfYz7PjrHKE3pLjJjyP6OC72NOVUfTo/hQNED3WfUXY+v+WyJFC8e4ghz1A==" }

Code:

200

Get Available License Keys Count | GET {{domain}}/api/v1/get-available-license-keys-count

Query

Key	Value	Description
api_key	2964c3c9-0b5d-4d89-b3ac-4668f30bc492	Required; API Key
product_id	3	Required; Product ID

Available Variables 1

Key	Value	Type
domain	https://demo.keevault.com	string