KND-REST-API参考手册（V1）_180918.pdf

北京凯恩帝数控REST API参考手册是一份由北京凯恩帝数控系统提供的技术文档，该文档详细介绍了KND K2000系统上的REST API接口。REST API是一种基于HTTP协议的软件接口，它允许开发者直接通过网络请求对数控系统进行控制和查询。本手册主要是为了向第三方开放部分数控系统的数据接口，通过标准化的接口与数控系统进行交互。 在手册中，首先介绍了REST API服务器的配置信息，如运行的系统、端口号、请求的基本地址等。为了让第三方能够正确地与数控系统进行通信，文档详细描述了请求和响应的数据格式以及必须使用的HTTP方法。 关于错误处理，手册强调了所有接口在发生错误时将返回特定的错误对象，包括错误码和错误消息。同时，提醒开发者注意HTTP状态码和content-type的使用，特别指出content-type应为“application/json;charset=gb2312”，而非常见的“utf-8”。 文档还提供了系统信息和版本的API接口。这个接口能够返回包括数控系统的唯一ID、系统类型、制造商、生产时间、软件版本号、FPGA版本号、梯图版本号以及用户可配置的轴列表。 另一个重要的接口是获取系统状态，包括运行状态、工作模式、是否准备就绪等信息。这里提供了详细的接口说明，解释了不同数值所代表的具体含义，如“run-status”代表运行状态，0代表CNC停止，1代表暂停，2代表运行中；而“opr-mode”代表工作模式，从录入方式到程序回零方式等。 此外，手册还提供了获取报警描述信息的接口。在这个部分，介绍了如何获取系统中的所有报警信息，以及各类报警的定义，例如参数开关报警、开关机报警、PLC报警、超程报警等。 整个手册清晰地描述了如何使用REST API进行数控系统的切削操作，涵盖了从系统基本信息的查询、到系统状态的监测，再到报警信息的管理等多个方面。为了确保第三方开发者能够正确使用这些接口，手册对请求和响应格式进行了详细规定，并对常见的错误处理进行了说明，使得数控系统的数据能够安全、有效地通过网络接口进行交互。