Keevault Contract API

Endpoints

Endpoints 4

Get Info | GET {{domain}}/api/contracts/v1/get-info

Headers

Key	Value	Description
Accept	application/json

Query

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677f	Contract key

Example Request

URL: {{domain}}/api/contracts/v1/get-info?contract_key=d375f538-9c96-11ef-b499-c87f5451677f

Headers

Key	Value	Description
Accept	application/json

Query

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677f	Contract key

Example Response

Body

{ "response": { "code": 1204, "message": "Contract found", "contract": { "id": 5, "name": "Test Contract X", "information": "Doofenshmirtz Evil Incorporated", "license_keys_quantity": 95, "product_id": 1, "can_get_info": 1, "can_generate": 1, "can_destroy": 1, "can_destroy_all": 1, "status": "active", "created_at": null, "updated_at": "2024-11-09T03:48:28.000000Z", "license_keys_count": 0 }, "product": { "id": 1, "external_reference": "", "source": "internal", "name": "Test Product", "post_url": "", "description": "Test Product", "created_at": "2024-11-06T01:12:04.000000Z", "updated_at": "2024-11-06T01:12:04.000000Z", "meta_data": [] }, "generator": { "id": 5, "method": "uuid", "prefix": "", "suffix": "", "function_name": "", "number_of_chunks": 4, "chunk_length": 4, "activation_limit": 1, "validity": 365, "charset": "0123456789ABCDEF", "created_at": "2024-11-09T00:27:01.000000Z", "updated_at": "2024-11-09T00:27:01.000000Z" }, "timestamp": 1731124309 }, "response_base64": "eyJjb2RlIjoxMjA0LCJtZXNzYWdlIjoiQ29udHJhY3QgZm91bmQiLCJjb250cmFjdCI6eyJpZCI6NSwibmFtZSI6IlRlc3QgQ29udHJhY3QgWCIsImluZm9ybWF0aW9uIjoiRG9vZmVuc2htaXJ0eiBFdmlsIEluY29ycG9yYXRlZCIsImxpY2Vuc2Vfa2V5c19xdWFudGl0eSI6OTUsInByb2R1Y3RfaWQiOjEsImNhbl9nZXRfaW5mbyI6MSwiY2FuX2dlbmVyYXRlIjoxLCJjYW5fZGVzdHJveSI6MSwiY2FuX2Rlc3Ryb3lfYWxsIjoxLCJzdGF0dXMiOiJhY3RpdmUiLCJjcmVhdGVkX2F0IjpudWxsLCJ1cGRhdGVkX2F0IjoiMjAyNC0xMS0wOVQwMzo0ODoyOC4wMDAwMDBaIiwibGljZW5zZV9rZXlzX2NvdW50IjowfSwicHJvZHVjdCI6eyJpZCI6MSwiZXh0ZXJuYWxfcmVmZXJlbmNlIjoiIiwic291cmNlIjoiaW50ZXJuYWwiLCJuYW1lIjoiVGVzdCBQcm9kdWN0IiwicG9zdF91cmwiOiIiLCJkZXNjcmlwdGlvbiI6IlRlc3QgUHJvZHVjdCIsImNyZWF0ZWRfYXQiOiIyMDI0LTExLTA2VDAxOjEyOjA0LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0xMS0wNlQwMToxMjowNC4wMDAwMDBaIiwibWV0YV9kYXRhIjpbXX0sImdlbmVyYXRvciI6eyJpZCI6NSwibWV0aG9kIjoidXVpZCIsInByZWZpeCI6IiIsInN1ZmZpeCI6IiIsImZ1bmN0aW9uX25hbWUiOiIiLCJudW1iZXJfb2ZfY2h1bmtzIjo0LCJjaHVua19sZW5ndGgiOjQsImFjdGl2YXRpb25fbGltaXQiOjEsInZhbGlkaXR5IjozNjUsImNoYXJzZXQiOiIwMTIzNDU2Nzg5QUJDREVGIiwiY3JlYXRlZF9hdCI6IjIwMjQtMTEtMDlUMDA6Mjc6MDEuMDAwMDAwWiIsInVwZGF0ZWRfYXQiOiIyMDI0LTExLTA5VDAwOjI3OjAxLjAwMDAwMFoifSwidGltZXN0YW1wIjoxNzMxMTI0MzA5fQ==", "private_key_used": "global", "signature": "Private key not set" }

Code:

200

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677fx	Contract key

urlencoded

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

Headers

Key	Value	Description
Accept	application/json

Body

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677f	Contract key
quantity	5	The quantity to generate

Example Request

URL: {{domain}}/api/contracts/v1/generate

Headers

Key	Value	Description
Accept	application/json

Body

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677f	Contract key
quantity	54	The quantity to generate

Example Response

Body

{ "response": { "code": 1300, "message": "Contract license keys generated", "licenseKeys": [ "5306754d-1f9f-4371-bcbc-e47092d7e0c2", "2d344851-4d7a-47d5-82b0-b78b929eb4b2", "bb09324d-d996-4a85-9836-7a97fd68f6fa", "41c4ec57-a495-4843-ab9d-b22eb40678d7", "229547fd-de61-47a8-8a1d-8523bf968349", "647bc7c7-45a5-4305-8c92-00588f9dc6d1", "306d9ca7-6232-41ff-8856-28dac11de683", "6a2a5cff-16c2-42dc-8768-66785a2ceb69", "8b13b4cd-4eec-484b-8f4c-4926d4f2f0ff", "fb52f290-3b43-42ab-ab46-e1efaa8a747c", "db097ef1-f13f-489a-9043-0bb8e34b770e", "202d668a-8c81-4d9e-b47b-b6b835133494", "3b60656a-3fda-41e9-89a9-14a28071fa6a", "c5a50528-c6c3-49e4-93c8-b65c5fc28c8e", "c79655ed-5b62-4257-a88a-7c7fd8ec5167", "5df2ddc5-8e32-4df3-993b-1cf420593a7a", "185dc7a1-9218-47d4-86d4-e1cfc81be9ff", "19b4f90c-fb84-44b7-8922-fdec763984b2", "4f304e0e-4c3e-4e75-8033-76053c4bb833", "b9d1c79b-3a51-4d8f-8e7e-303e84b29267", "8e68360b-bb61-43a5-afb1-0a41d0328efa", "382cc213-9397-4bdb-9e12-083ae340e8a6", "1b6c07c5-01ad-411c-99d4-435b4975c6e8", "1bc233b8-9819-4277-a719-093bc20ad197", "3a39c9a9-6111-4677-863b-fe2346f0729d", "ef2f2c2c-229b-4d02-ad79-a849cc209ed6", "c569ff8c-db64-40fb-94b1-aef2e698470a", "318b071a-0254-4aca-aeee-f7bbd55ba74d", "fb1adad0-e75b-447c-ab50-e960c61e45f3", "e68aa15e-73c1-4bc7-8abf-42a7e6f40d16", "1bf50809-cc4a-4292-b399-a964c248feae", "42b3f456-de49-410f-adc0-b80e39b04763", "65f95480-fea8-4507-96a6-d6205c6acc7c", "6d7da816-b308-4fa2-af64-dea87ea87e76", "abfed5f8-eb62-4d03-b295-ab7414fafd20", "19fc73b4-89dc-421a-a559-fb746ba236fa", "6190653d-e8e7-438a-84d4-bc9114f5d390", "026e4d25-5a2e-4e87-b3b1-a3035c6561d1", "e114ea83-a3fd-4555-a0f7-af694d29ef6c", "372924c0-3842-4bac-b2ec-ec5c9eb10f07", "c7dcdbb2-3890-47dc-b789-2b52162686b2", "82fcd6de-7346-4ebc-8ade-065a0261e18d", "80c3a7cf-24f6-47d7-8f1f-a91ba7f58898", "fa1e1fd2-bd05-4139-8413-a9ae29c49f61", "bc31b2d7-08cb-4eb0-a125-2c16420ee5a6", "b1aab28e-e5ee-4629-bf73-f41d0e2f8e7e", "dc5cad2b-b4fe-4519-b875-264036f295b1", "7e890c52-9485-42e1-abc9-8144addd2d19", "8ce93d1a-fe76-4be1-a18b-0e3448b68822", "715a5a94-9e22-4222-b6fd-0fd5faa0dea8", "d4789df3-d1d7-45af-99ba-b949bdef7baf", "a80c9685-15b1-464a-b434-96204dd9ba28", "03ac763a-6f76-472a-bbed-1f793dfe02d1", "d7a4cb0d-c8fe-4aad-a038-0279353da7b5" ], "timestamp": 1731124465 }, "response_base64": "eyJjb2RlIjoxMzAwLCJtZXNzYWdlIjoiQ29udHJhY3QgbGljZW5zZSBrZXlzIGdlbmVyYXRlZCIsImxpY2Vuc2VLZXlzIjpbIjUzMDY3NTRkLTFmOWYtNDM3MS1iY2JjLWU0NzA5MmQ3ZTBjMiIsIjJkMzQ0ODUxLTRkN2EtNDdkNS04MmIwLWI3OGI5MjllYjRiMiIsImJiMDkzMjRkLWQ5OTYtNGE4NS05ODM2LTdhOTdmZDY4ZjZmYSIsIjQxYzRlYzU3LWE0OTUtNDg0My1hYjlkLWIyMmViNDA2NzhkNyIsIjIyOTU0N2ZkLWRlNjEtNDdhOC04YTFkLTg1MjNiZjk2ODM0OSIsIjY0N2JjN2M3LTQ1YTUtNDMwNS04YzkyLTAwNTg4ZjlkYzZkMSIsIjMwNmQ5Y2E3LTYyMzItNDFmZi04ODU2LTI4ZGFjMTFkZTY4MyIsIjZhMmE1Y2ZmLTE2YzItNDJkYy04NzY4LTY2Nzg1YTJjZWI2OSIsIjhiMTNiNGNkLTRlZWMtNDg0Yi04ZjRjLTQ5MjZkNGYyZjBmZiIsImZiNTJmMjkwLTNiNDMtNDJhYi1hYjQ2LWUxZWZhYThhNzQ3YyIsImRiMDk3ZWYxLWYxM2YtNDg5YS05MDQzLTBiYjhlMzRiNzcwZSIsIjIwMmQ2NjhhLThjODEtNGQ5ZS1iNDdiLWI2YjgzNTEzMzQ5NCIsIjNiNjA2NTZhLTNmZGEtNDFlOS04OWE5LTE0YTI4MDcxZmE2YSIsImM1YTUwNTI4LWM2YzMtNDllNC05M2M4LWI2NWM1ZmMyOGM4ZSIsImM3OTY1NWVkLTViNjItNDI1Ny1hODhhLTdjN2ZkOGVjNTE2NyIsIjVkZjJkZGM1LThlMzItNGRmMy05OTNiLTFjZjQyMDU5M2E3YSIsIjE4NWRjN2ExLTkyMTgtNDdkNC04NmQ0LWUxY2ZjODFiZTlmZiIsIjE5YjRmOTBjLWZiODQtNDRiNy04OTIyLWZkZWM3NjM5ODRiMiIsIjRmMzA0ZTBlLTRjM2UtNGU3NS04MDMzLTc2MDUzYzRiYjgzMyIsImI5ZDFjNzliLTNhNTEtNGQ4Zi04ZTdlLTMwM2U4NGIyOTI2NyIsIjhlNjgzNjBiLWJiNjEtNDNhNS1hZmIxLTBhNDFkMDMyOGVmYSIsIjM4MmNjMjEzLTkzOTctNGJkYi05ZTEyLTA4M2FlMzQwZThhNiIsIjFiNmMwN2M1LTAxYWQtNDExYy05OWQ0LTQzNWI0OTc1YzZlOCIsIjFiYzIzM2I4LTk4MTktNDI3Ny1hNzE5LTA5M2JjMjBhZDE5NyIsIjNhMzljOWE5LTYxMTEtNDY3Ny04NjNiLWZlMjM0NmYwNzI5ZCIsImVmMmYyYzJjLTIyOWItNGQwMi1hZDc5LWE4NDljYzIwOWVkNiIsImM1NjlmZjhjLWRiNjQtNDBmYi05NGIxLWFlZjJlNjk4NDcwYSIsIjMxOGIwNzFhLTAyNTQtNGFjYS1hZWVlLWY3YmJkNTViYTc0ZCIsImZiMWFkYWQwLWU3NWItNDQ3Yy1hYjUwLWU5NjBjNjFlNDVmMyIsImU2OGFhMTVlLTczYzEtNGJjNy04YWJmLTQyYTdlNmY0MGQxNiIsIjFiZjUwODA5LWNjNGEtNDI5Mi1iMzk5LWE5NjRjMjQ4ZmVhZSIsIjQyYjNmNDU2LWRlNDktNDEwZi1hZGMwLWI4MGUzOWIwNDc2MyIsIjY1Zjk1NDgwLWZlYTgtNDUwNy05NmE2LWQ2MjA1YzZhY2M3YyIsIjZkN2RhODE2LWIzMDgtNGZhMi1hZjY0LWRlYTg3ZWE4N2U3NiIsImFiZmVkNWY4LWViNjItNGQwMy1iMjk1LWFiNzQxNGZhZmQyMCIsIjE5ZmM3M2I0LTg5ZGMtNDIxYS1hNTU5LWZiNzQ2YmEyMzZmYSIsIjYxOTA2NTNkLWU4ZTctNDM4YS04NGQ0LWJjOTExNGY1ZDM5MCIsIjAyNmU0ZDI1LTVhMmUtNGU4Ny1iM2IxLWEzMDM1YzY1NjFkMSIsImUxMTRlYTgzLWEzZmQtNDU1NS1hMGY3LWFmNjk0ZDI5ZWY2YyIsIjM3MjkyNGMwLTM4NDItNGJhYy1iMmVjLWVjNWM5ZWIxMGYwNyIsImM3ZGNkYmIyLTM4OTAtNDdkYy1iNzg5LTJiNTIxNjI2ODZiMiIsIjgyZmNkNmRlLTczNDYtNGViYy04YWRlLTA2NWEwMjYxZTE4ZCIsIjgwYzNhN2NmLTI0ZjYtNDdkNy04ZjFmLWE5MWJhN2Y1ODg5OCIsImZhMWUxZmQyLWJkMDUtNDEzOS04NDEzLWE5YWUyOWM0OWY2MSIsImJjMzFiMmQ3LTA4Y2ItNGViMC1hMTI1LTJjMTY0MjBlZTVhNiIsImIxYWFiMjhlLWU1ZWUtNDYyOS1iZjczLWY0MWQwZTJmOGU3ZSIsImRjNWNhZDJiLWI0ZmUtNDUxOS1iODc1LTI2NDAzNmYyOTViMSIsIjdlODkwYzUyLTk0ODUtNDJlMS1hYmM5LTgxNDRhZGRkMmQxOSIsIjhjZTkzZDFhLWZlNzYtNGJlMS1hMThiLTBlMzQ0OGI2ODgyMiIsIjcxNWE1YTk0LTllMjItNDIyMi1iNmZkLTBmZDVmYWEwZGVhOCIsImQ0Nzg5ZGYzLWQxZDctNDVhZi05OWJhLWI5NDliZGVmN2JhZiIsImE4MGM5Njg1LTE1YjEtNDY0YS1iNDM0LTk2MjA0ZGQ5YmEyOCIsIjAzYWM3NjNhLTZmNzYtNDcyYS1iYmVkLTFmNzkzZGZlMDJkMSIsImQ3YTRjYjBkLWM4ZmUtNGFhZC1hMDM4LTAyNzkzNTNkYTdiNSJdLCJ0aW1lc3RhbXAiOjE3MzExMjQ0NjV9", "private_key_used": "global", "signature": "Private key not set" }

Code:

200

urlencoded

Destroy | POST {{domain}}/api/contracts/v1/destroy

Headers

Key	Value	Description
Accept	application/json

Body

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677f	Contract key
license_key	d9d30b83-5e16-4c53-8764-38ef0cf4d2a1	The license key to delete

urlencoded

Destroy All | POST {{domain}}/api/contracts/v1/destroy-all

Headers

Key	Value	Description
Accept	application/json

Body

Key	Value	Description
contract_key	d375f538-9c96-11ef-b499-c87f5451677f	Contract key

Available Variables 1

Key	Value	Type
domain	https://keevault-new.local	default