跳到主要内容
版本:Next

API接口概述

1.概述

1.1场景说明

API(Application Programming Interface,应用程序编程接口)能够高效实现不同软件系统间的交互,将应用程序的数据进行传输与共享;

软件与第三方系统如ERP、MES或IOT 平台的信息化对接,存在许多的困难:

  • 设备接口缺乏标准,难以快速获取数据,实施成本高;
  • 第三方系统接口太多、标准太多,定制开发工作量大;
  • 接口现场调试或需求变更,需要专业的IT 人员进厂处理,人员成本高、项目推进效率低下;
  • 定制接口太多,后续长期维护或迭代困难;

CMS作为设备与第三方系统的统一对接平台,提供API接口互联功能。可根据第三方系统的API对接需求,自行进行设备接口的可视化设计,并在项目中实现统一管理,快速完成与第三方系统的信息交互;

通过 API 接口,实现CMS与其他系统无缝对接,打破数据孤岛,实现多系统间的协同工作;

1.2功能介绍

1)接口管理

支持与第三方系统(如ERP、MES等)的HTTP接口对接,允许配置多个服务地址、超时及重试策略。通过接口列表可批量管理接口,支持检索、删除和导入导出。全局参数(Header/Query/Body)可统一设置,支持灵活启用或停用,避免重复配置,确保调用时的兼容性和效率。

2)接口配置

用于定义接口的基础信息(名称、地址、请求方法)及参数细节。支持Header和Body参数配置,Body类型涵盖form-data、JSON等,可手动输入或导入数据结构。返回响应需预定义数据结构,支持JSON导入和节点级数据提取,便于后续结果解析与变量赋值,确保接口调用的规范性和可复用性。

3)接口调试

提供实时调试功能,可直接发送请求并查看响应结果。支持动态修改参数配置并保存,响应内容可美化或原始格式查看,附带HTTP状态码、耗时等统计信息。调试结果支持生成cURL命令,便于跨平台验证接口有效性,帮助快速定位配置问题,提升接口开发与维护效率。

4)接口调用

支持前端或后端调用已配置接口,触发事件。调用时可传入固定值、变量或表达式,动态适配业务场景。返回结果可提取并赋值至变量,支持数据流转与后续逻辑处理,实现与第三方系统的无缝集成与自动化交互。