跳转到主要内容
API 参考文档 记录了 系统 API 的所有接口。系统 API 是用于以编程方式管理 实例的 REST 接口。各页面分别介绍一项操作,包括 HTTP 方法、路径、参数和响应架构;内容直接根据系统 API 的 OpenAPI 规范生成。 要了解这些接口所基于的概念,包括身份验证、/api.rsc/ 接口约定、CORS 和筛选,请先阅读知行之桥用户手册中的系统 API 指南。本参考文档按资源函数分组,逐项说明各个接口。

资源

资源是可以使用标准 HTTP 方法(GETPOSTPUTDELETE)查询、创建、更新和删除的对象。每种资源都通过 /api.rsc/<resource> 公开。

函数

函数用于执行资源 CRUD 之外的管理和端口操作,通过向 /api.rsc/<actionName> 发送 HTTP POST 请求调用。这些函数可用于清理日志和文件夹、复制端口和工作区、创建和交换证书、导入和导出设置及加密密钥、重新排队和统计消息、发送和接收文件,以及检索交易日志。 完整函数列表及其参数请参阅函数页面。