黑湖科技MESAPI接口文档

需积分: 50 20 下载量 172 浏览量 更新于2024-07-09 2 收藏 61KB DOCX 举报
"黑湖接口文档MESAPI-V320210311.docx 是一份关于黑湖 MES API 的详细文档,包含了接口登录、导入物料等关键业务的接口说明,适用于集成与黑湖系统交互的场景。文档中列出了具体的接口地址、请求参数、返回参数以及测试用例,以便开发者进行接口调用和功能实现。" **黑湖接口文档 MESAPI-V3** 这份文档主要介绍了两个核心的接口:**接口登录** 和 **导入物料**,这两个接口对于与黑湖 Manufacturing Execution System (MES) 的数据交互至关重要。 ### 1. 接口登录 #### 业务流程及接口适用场景 接口登录是所有后续业务操作的基础,因为用户需要获取有效的 `token` 才能访问其他业务接口。这个接口适用于用户身份验证,确保只有授权的用户或系统可以进行数据交换。 #### 技术方案 使用 HTTP POST 请求向指定的接口地址发送 JSON 格式的请求数据,包含账号登录或手机号登录的参数。 #### 关键业务逻辑 - 账号登录:输入 `type`(通常为1表示账号登录)、`code`(可能代表地区代码)、`username`(用户名)和 `password`(密码)。 - 手机号登录:输入 `phone`(手机号)和 `password`(密码)。 #### 测试用例 测试用例中展示了如何构造请求头(包括 `Content-Type` 和 `X-AUTH`),以及请求参数的示例,以便获取返回的 `token`。 ### 2. 导入物料 #### 业务流程及接口适用场景 物料导入接口用于将特定分类的物料数据从外部系统传输到 MES,如U8系统的01、02、03、08、09大类的一级物料,但不包括二级分类。 #### 技术方案 使用 HTTP POST 请求,携带特定的请求头和 JSON 数据,其中 `AuxiliaryUnit` 可能用于转换单位。 #### 关键业务逻辑 - 物料分类:只支持指定的大类物料,不处理二级分类。 - 返回结果:包含 `data` 和 `failureList`,`data` 存储成功导入的数据,而 `failureList` 列出导入失败的物料。 #### 测试用例 测试用例中展示了如何构造请求头和请求体,以便测试物料导入接口的正确性。 该文档为开发人员提供了全面的指南,帮助他们理解和实现与黑湖 MES 的集成,确保能够安全地登录系统并正确地导入物料数据。开发者可以根据这些接口描述进行相应的编程,以实现与黑湖系统的数据交换和业务流程自动化。