OpenAPI 接口定义

关于本文档

慧表 NxCells 通过一套 HTTP 开放接口(OpenController)对外提供数据能力:获取账套与访问令牌、读写报表数据、上传下载图片附件、执行作业等,供第三方系统与慧表对接。

全部接口以 JSON 收发,统一返回 Code / Message;除特别注明 GET 的接口外均为 POST。

以下接口按用途分成 6 章,可从左侧目录逐章查看。

通用约定

项目

说明

接口基础地址

http://{host}:{port}/api/Open/{Action}(ASP.NET Web API 默认路由 api/{controller}/{action},下文各节仅列 Action 与请求方式)

请求方式

除特别注明 GET 的接口外均为 POST,请求/响应均为 application/json(UTF-8)

Code 语义

0 成功;1 业务拒绝(权限不足、数据不存在等);2 系统异常(返回 ex.Message)

访问令牌

AccessToken 请全局缓存;令牌为空 / 失效时业务接口返回 Code=2,"访问被拒绝,访问令牌已失效"

全局开关

服务端 AllowOpenApi 关闭时,所有开放接口返回 Code=1,"访问被拒绝,当前版本不支持开发接口调用"

安全过滤

LoginName、JobName、QueryName、ResourceID 等字符串入参做 SQL 注入过滤;Password 为加密串,空格将被还原为 +

资源目录

图片/附件分别落地 temp/{账套}/report/{报表ID}/image/(图片)与 temp/{账套}/report/{报表ID}/affix/(附件),返回 Url 为相对路径,需拼接站点根地址访问

接口目录

💬在线咨询
快速响应顾问在线, 随时沟通需求
☎电话咨询
0512-67316672工作日 8:30-18:00
18036137281(微信同号)
📄白皮书
免费下载《非标制造业零代码
数字化转型白皮书》
↑顶部