GetKeyManager is coming soon! 🎉 See here to know what’s new

Create Contract

Endpoint Details

  • Method: POST
  • Path: /api/v1/create-contract
  • Authentication: API Key (required)

Request Headers

None specified in Postman

Request Parameters

ParameterTypeRequiredDescriptionExample
api_keytextYesN/Abd494175-4582-43dd-9c32-c58f45e2ec91
contract_keytextYesN/A6dabe9fa-3512-49b4-beb5-7f837b510ec3-1234
contract_nametextYesN/ATest Contract
contract_informationtextYesN/ATest information
product_idtextYesN/A1
license_keys_quantitytextYesN/A65
statustextYesN/Aactive
can_get_infotextYesN/A1
can_generatetextYesN/A1
can_destroytextYesN/A1
can_destroy_alltextYesN/A1

Response Examples

This endpoint has 2 documented response example(s) in the Postman collection.

Contract created

HTTP Status: 200 OK

Response Body:

{
  "response": {
    "code": 841,
    "message": "contract created",
    "contract": {
      "contract_key": "6dabe9fa-3512-49b4-beb5-7f837b510ec3-1234",
      "name": "Test Contract",
      "information": "Test information",
      "product_id": "1",
      "license_keys_quantity": "65",
      "status": "active",
      "can_get_info": "1",
      "can_generate": "1",
      "can_destroy": "1",
      "can_destroy_all": "1",
      "updated_at": "2024-11-10T02:13:10.000000Z",
      "created_at": "2024-11-10T02:13:10.000000Z",
      "id": 10,
      "license_keys_count": 0
    },
    "timestamp": 1731204790
  },
  "response_base64": "eyJjb2RlIjo4NDEsIm1lc3NhZ2UiOiJjb250cmFjdCBjcmVhdGVkIiwiY29udHJhY3QiOnsiY29udHJhY3Rfa2V5IjoiNmRhYmU5ZmEtMzUxMi00OWI0LWJlYjUtN2Y4MzdiNTEwZWMzLTEyMzQiLCJuYW1lIjoiVGVzdCBDb250cmFjdCIsImluZm9ybWF0aW9uIjoiVGVzdCBpbmZvcm1hdGlvbiIsInByb2R1Y3RfaWQiOiIxIiwibGljZW5zZV9rZXlzX3F1YW50aXR5IjoiNjUiLCJzdGF0dXMiOiJhY3RpdmUiLCJjYW5fZ2V0X2luZm8iOiIxIiwiY2FuX2dlbmVyYXRlIjoiMSIsImNhbl9kZXN0cm95IjoiMSIsImNhbl9kZXN0cm95X2FsbCI6IjEiLCJ1cGRhdGVkX2F0IjoiMjAyNC0xMS0xMFQwMjoxMzoxMC4wMDAwMDBaIiwiY3JlYXRlZF9hdCI6IjIwMjQtMTEtMTBUMDI6MTM6MTAuMDAwMDAwWiIsImlkIjoxMCwibGljZW5zZV9rZXlzX2NvdW50IjowfSwidGltZXN0YW1wIjoxNzMxMjA0NzkwfQ==",
  "private_key_used": "global",
  "signature": "Private key not set"
}

Incorrect data found

HTTP Status: 200 OK

Response Body:

{
  "response": {
    "code": 825,
    "message": "Incorrect data found",
    "errors": {
      "contract_key": "Contract key is required and must be unique.",
      "contract_name": "Contract name is required.",
      "contract_information": "Contract information is required.",
      "product_id": "Product Id must be a valid product Id.",
      "license_keys_quantity": "License keys quantity must be 1 or more.",
      "status": "Status must be active or inactive",
      "can_get_info": "Can get info must be 1 for true or 0 for false",
      "can_generate": "Can generate must be 1 for true or 0 for false",
      "can_destroy": "Can destroy must be 1 for true or 0 for false",
      "can_destroy_all": "Can destroy all must be 1 for true or 0 for false"
    },
    "timestamp": 1731204923
  },
  "response_base64": "eyJjb2RlIjo4MjUsIm1lc3NhZ2UiOiJJbmNvcnJlY3QgZGF0YSBmb3VuZCIsImVycm9ycyI6eyJjb250cmFjdF9rZXkiOiJDb250cmFjdCBrZXkgaXMgcmVxdWlyZWQgYW5kIG11c3QgYmUgdW5pcXVlLiIsImNvbnRyYWN0X25hbWUiOiJDb250cmFjdCBuYW1lIGlzIHJlcXVpcmVkLiIsImNvbnRyYWN0X2luZm9ybWF0aW9uIjoiQ29udHJhY3QgaW5mb3JtYXRpb24gaXMgcmVxdWlyZWQuIiwicHJvZHVjdF9pZCI6IlByb2R1Y3QgSWQgbXVzdCBiZSBhIHZhbGlkIHByb2R1Y3QgSWQuIiwibGljZW5zZV9rZXlzX3F1YW50aXR5IjoiTGljZW5zZSBrZXlzIHF1YW50aXR5IG11c3QgYmUgMSBvciBtb3JlLiIsInN0YXR1cyI6IlN0YXR1cyBtdXN0IGJlIGFjdGl2ZSBvciBpbmFjdGl2ZSIsImNhbl9nZXRfaW5mbyI6IkNhbiBnZXQgaW5mbyBtdXN0IGJlIDEgZm9yIHRydWUgb3IgMCBmb3IgZmFsc2UiLCJjYW5fZ2VuZXJhdGUiOiJDYW4gZ2VuZXJhdGUgbXVzdCBiZSAxIGZvciB0cnVlIG9yIDAgZm9yIGZhbHNlIiwiY2FuX2Rlc3Ryb3kiOiJDYW4gZGVzdHJveSBtdXN0IGJlIDEgZm9yIHRydWUgb3IgMCBmb3IgZmFsc2UiLCJjYW5fZGVzdHJveV9hbGwiOiJDYW4gZGVzdHJveSBhbGwgbXVzdCBiZSAxIGZvciB0cnVlIG9yIDAgZm9yIGZhbHNlIn0sInRpbWVzdGFtcCI6MTczMTIwNDkyM30=",
  "private_key_used": "global",
  "signature": "Private key not set"
}
Last updated on