API Reference
Communication with the TonCut for Automation program is based on data in JSON format. You can work with the program in two ways - in command line mode or in Websocket server mode. Command line mode is perfect for batch processing, while server mode can be used for all other applications. Additionally, the program can run as a Windows service, so the optimization service can always be available.
In short, you need to provide input data (Input) to the program, and the program will generate results (Output). Input and Output are so-called Data Groups. There is also Configuration, but it is not required, so you can skip it at the beginning.
COMMAND LINE
In command line mode, data is provided in the form of files and/or stdin
.
The results can be saved to a file or printed to stdout
.
WEBSOCKET API
In server mode, a special Websocket API is used to communicate with the program. The API is super simple and is based on commands and events. After establishing a connection, you can send commands and receive responses as well as events.
JUST GETTING STARTED?
First, install the program and make sure it is working properly. Then, we suggest that you start by running the examples and analyzing their source code. Finally, it is worth returning to this documentation to better understand the API.
Remember that the examples by default use port 8080
and the ws:
protocol (without SSL).
So if your configuration is different, you should also modify the examples!
SEE IN ACTION
If you want to see TonCut for Automation in action, take a look at our other product - TonCut Easy Online. This application actually uses TonCut for Automation to perform cutting optimization.
HELP WITH INTEGRATION
We are here to help you with any questions or issues you may have. You can reach us through the contact form on our website. We also offer full integration services for your projects - we have the skills and experience to handle any challenge. Check out our website to learn more about our capabilities and solutions.