Developer Documentation. API integration

Using our API, you can use the EasyPackMaker engine to integrate in your web application. The API uses HTTP as the main protocol, which means it is suitable for development in any programming language that can work with HTTP libraries (cURL and others).

The API supports POST requests that use JSON arguments. The API always returns a response in JSON format.

To get access you need:

  • Register or log in to our site, if necessary.
  • In your Personal Account, read and accept the End User License Agreement.
  • Send us an API activation request via the feedback form. Describe how you will use our interface.
  • After reviewing your request, the account will switch to API mode*.
  • You will receive a service access code ("API Password" in Personal Account) and implement interaction.

* After switching, using the account in normal mode is not possible.

Request creation

Description

The method creates a request to the API and, if successful, returns the calculated packaging model.

Method POST
URL https://easypackmaker.com/generator/api
Response format JSON
Request
Parameters Description Type Required
UserName The Username registered as an API user. string(255) Yes
Token See Request Signature. string Yes
OrderId Order ID in the customer system. string(20) Yes
ModelName The name of the model. All available names are presented in the table. string(20) Yes
ModelParams An array of data on the main parameters of the model. All sizes, material thickness and units. See Structure of the ModelParams Object. object Yes
ModelOptions Array of data of additional model parameters. Glue areas, information about knives, shape of elements, etc. See Structure of the ModelOptions Object. object Yes

Request examples:

{
   "UserName":"User",
   "Token":"4a4d74a9793001864428800ad2a42c7b7735d3851d0f59db914173d00ce38240",
   "OrderId":"1001",
   "ModelName":"A10_10_03_03",
   "ModelParams":
   {
      "L":"100",
      "W":"50",
      "D":"150",
      "Th":"0.5",
      "Units":"mm"
   },
   "ModelOptions":
   {
      "DimensionType":"Crease",
      "KnifeInfo":true,
      "GlueZone":false
   }
}
{
   "UserName":"User",
   "Token":"f6a0df7d78ed42002b7a3f3db5dd6bff38567e62213dac404e787fb7f153bd48",
   "OrderId":"1002",
   "ModelName":"fefco_0200",
   "ModelParams":
   {
      "L":"250",
      "W":"200",
      "D":"150",
      "Th":"4",
      "Units":"mm"
   },
   "ModelOptions":
   {
      "FluteDir":"Vertical",
      "DimensionType":"In",
      "GlueZone":false,
      "KnifeInfo":true
   }
}
{
   "UserName":"User",
   "Token":"c03f8ffe9c991c81fc368c2a27107638da38907e32b3966e797d54dda251fd13",
   "OrderId":"1003",
   "ModelName":"Env_C5",
   "ModelParams":null,
   "ModelOptions":
   {
      "GlueZone":false,
      "KnifeInfo":true
   }
}
Response
Parameters Description Type Required
Status Model calculation status. Possible values: "Success", "Failed". string(20) Yes
ErrorCode Error code. If no error has occurred, the value "0" is returned. number(2) Yes
Details Error description string No
Model The calculated model. The data is encoded in MIME base64 format. To obtain a model in PDF format, use the MIME base64 decoding function. string No

Examples of response:

{
   "Status":"Success",
   "ErrorCode":0,
   "Model":"JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL01lZGlhQm94IFswIDAgOTAwLjcwODcgNzIyLjgzNDZdCi9SZXNvdXJjZXMgMiAwIFIKL0NvbnRlbnRzIDQgMCBSPj4KZW5kb2JqCjQgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZSAvTGVuZ3RoIDQ0MD4+CnN0cmVhbQp4nI1Uy07DMBC85yv2CAcWr9\/ukQoOHJCq5AeqUiRQA4KCQHw9bpv6ETstuTSa7szOvsLgviFk\/oHv5nrecpi3sAegnT80ghuUjDQoI5GRMtBDwEhatGQdbKBtpHZIQrg0MmBZpFEclbMyjQxYFun9UO7HOo6cSZNyAzbmjmqRAp0wzIcN\/rNShpcdtSxwqpQE1agdd3kpA5YVnWjWjb8P82DARr9X4z+4M6iFsQxWfaVZseBjygBxOxjfxGpr2JlxlNw+9iTqVbllR6vc2LkadsZfye3jCiV69UksTiyRMgqlEJQuUcCyJardQ8BGl6ORJGX3ELCpyykvYqLdwfiRGiBDEoVgJh18DTuToeQmA416p5chtVdyYwdq2Bl\/JTdZhkRvsqOTqxAHPL64f8\/ComK78rVExUntbBwQUhYFCe6RqvpNB9d3BMQPH\/HuCW675h18Ug2r7ZB0u3oFH6gUcqP8IJXxsHHQPcJF+\/y73s5AEKGFH+DSH0l\/Cd2LF4JF0GeFPk3rS4r686\/PmbdMIpPdK\/BpBcEShY\/1crv2IuRcKaKmRchFke7tc7mZAddEmcYfHypzOAplbmRzdHJlYW0KZW5kb2JqCjEgMCBvYmoKPDwvVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSIF0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNTk1LjI4MDAgODQxLjg5MDBdCj4+CmVuZG9iago1IDAgb2JqClsvU2VwYXJhdGlvbiAvKmN1dAovRGV2aWNlQ01ZSyA8PAovUmFuZ2UgWzAgMSAwIDEgMCAxIDAgMV0gL0MwIFswIDAgMCAwXSAKL0MxIFswLjAwMCAxLjAwMCAxLjAwMCAwLjAwMF0gCi9GdW5jdGlvblR5cGUgMiAvRG9tYWluIFswIDFdIC9OIDE+Pl0KZW5kb2JqCjYgMCBvYmoKWy9TZXBhcmF0aW9uIC8qY3JlYXNlCi9EZXZpY2VDTVlLIDw8Ci9SYW5nZSBbMCAxIDAgMSAwIDEgMCAxXSAvQzAgWzAgMCAwIDBdIAovQzEgWzEuMDAwIDAuMDAwIDEuMDAwIDAuMDAwXSAKL0Z1bmN0aW9uVHlwZSAyIC9Eb21haW4gWzAgMV0gL04gMT4+XQplbmRvYmoKNyAwIG9iagpbL1NlcGFyYXRpb24gLypwZXJmCi9EZXZpY2VDTVlLIDw8Ci9SYW5nZSBbMCAxIDAgMSAwIDEgMCAxXSAvQzAgWzAgMCAwIDBdIAovQzEgWzAuMDAwIDAuMDAwIDEuMDAwIDAuMDAwXSAKL0Z1bmN0aW9uVHlwZSAyIC9Eb21haW4gWzAgMV0gL04gMT4+XQplbmRvYmoKOCAwIG9iagpbL1NlcGFyYXRpb24gLypnbHVlCi9EZXZpY2VDTVlLIDw8Ci9SYW5nZSBbMCAxIDAgMSAwIDEgMCAxXSAvQzAgWzAgMCAwIDBdIAovQzEgWzAuMDAwIDAuMDAwIDAuNDAwIDAuMDAwXSAKL0Z1bmN0aW9uVHlwZSAyIC9Eb21haW4gWzAgMV0gL04gMT4+XQplbmRvYmoKOSAwIG9iagpbL1NlcGFyYXRpb24gLyppbmZvCi9EZXZpY2VDTVlLIDw8Ci9SYW5nZSBbMCAxIDAgMSAwIDEgMCAxXSAvQzAgWzAgMCAwIDBdIAovQzEgWzAuMDAwIDAuMDAwIDAuMDAwIDAuNjAwXSAKL0Z1bmN0aW9uVHlwZSAyIC9Eb21haW4gWzAgMV0gL04gMT4+XQplbmRvYmoKMTAgMCBvYmoKWy9TZXBhcmF0aW9uIC8qdGV4dAovRGV2aWNlQ01ZSyA8PAovUmFuZ2UgWzAgMSAwIDEgMCAxIDAgMV0gL0MwIFswIDAgMCAwXSAKL0MxIFswLjAwMCAwLjAwMCAwLjAwMCAwLjkwMF0gCi9GdW5jdGlvblR5cGUgMiAvRG9tYWluIFswIDFdIC9OIDE+Pl0KZW5kb2JqCjExIDAgb2JqCjw8L0ZpbHRlciAvRmxhdGVEZWNvZGUgL0xlbmd0aCAzNjQ+PgpzdHJlYW0KeJxdUstugzAQvPMVPqaHCEwagiWEREmQOPSh0n4AgSVFKgYZcuDvu7t20qpIWOOxZ3ZWaz8vj6XuF+G\/mbGpYBFdr1sD83g1DYgzXHrtyVC0fbO4Ha\/NUE+ej+JqnRcYSt2NXpL473g2L2YVm6wdz\/Dg+a+mBdPri9h85hXuq+s0fcMAehGBl6aihQ59nuvppR5A+Czbli2e98u6Rc3vjY91AhHyXtoszdjCPNUNmFpfwEuCIBVJUaQe6PbfWWQV5+7v1UOBS4Bf6iVxhDg+4BIGIRFKIlYhEzImYkfEoyVyIkiirETukMhcfTJFTDFuBaW6BWi+aoPlApZl5BO7IhlhKhJIrIvY1ToR3ttkEeGY7oQ5Y8X8jlvIWBsxfrK8Ipwzv2fPE+PDkfI7T+KV9TxyX+wpLe88JWHnSTmV86S2lfOknKqwOHbdc7c0Dnow9zk3V2NwxPyqeLY01V7D\/eFN40Qq+n8Afw22qQplbmRzdHJlYW0KZW5kb2JqCjEyIDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0Jhc2VGb250IC9IZWx2ZXRpY2EKL1N1YnR5cGUgL1R5cGUxCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9Ub1VuaWNvZGUgMTEgMCBSCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQovRm9udCA8PAovRjEgMTIgMCBSCj4+Ci9YT2JqZWN0IDw8Cj4+Ci9Db2xvclNwYWNlIDw8Ci9DUzEgNSAwIFIKL0NTMiA2IDAgUgovQ1MzIDcgMCBSCi9DUzQgOCAwIFIKL0NTNSA5IDAgUgovQ1M2IDEwIDAgUgo+Pgo+PgplbmRvYmoKMTMgMCBvYmoKPDwKL1RpdGxlIChlY21hIEExMC4xMC4wMy4wMyBMPTEwMCwgVz01MCwgRD0xNTApCi9BdXRob3IgKFVzZXIpCi9DcmVhdG9yIChFYXN5UGFja01ha2VyLmNvbSkKL1Byb2R1Y2VyIChFYXN5UGFja01ha2VyIDMuNDIpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyMDA0MDQxODI3NTYpCj4+CmVuZG9iagoxNCAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMSAwIFIKL09wZW5BY3Rpb24gWzMgMCBSIC9GaXRdCj4+CmVuZG9iagp4cmVmCjAgMTUKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwNjMxIDAwMDAwIG4gCjAwMDAwMDIyMjggMDAwMDAgbiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMTIxIDAwMDAwIG4gCjAwMDAwMDA3MjIgMDAwMDAgbiAKMDAwMDAwMDg4MCAwMDAwMCBuIAowMDAwMDAxMDQxIDAwMDAwIG4gCjAwMDAwMDEyMDAgMDAwMDAgbiAKMDAwMDAwMTM1OSAwMDAwMCBuIAowMDAwMDAxNTE4IDAwMDAwIG4gCjAwMDAwMDE2NzggMDAwMDAgbiAKMDAwMDAwMjExMyAwMDAwMCBuIAowMDAwMDAyNDE4IDAwMDAwIG4gCjAwMDAwMDI1OTQgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxNQovUm9vdCAxNCAwIFIKL0luZm8gMTMgMCBSCj4+CnN0YXJ0eHJlZgoyNjY5CiUlRU9GCg=="
}
{
   "Status":"Failed",
   "ErrorCode":2,
   "Details":"Request format error"
}

Error code descriptions:

ErrorCodeDetailsDescription
0 The model is calculated. No errors
1 Bad request Bad request error. The server was unable to process the request
2 Request format error Error in the request format. One or more required parameters are missing or incorrect
3 You don't have enough rights The specified user was not found or not authorized to use API
4 Insufficient funds Paid period expired / download limit reached / insufficient funds. Details on the Balance page
5 Token error Error generating request signature. Follow the instructions for creating a token or use a ready-made solution
6 Model values error Parameter or option error. The following is a detailed description of this error