VeryReport · 帮助文档

开放 API 概述

VeryReport 开放 API 能力概述、认证方式、错误码与完整接口目录。

1. 概述

VeryReport 开放 API 提供基于 HMAC-SHA256 签名的 REST 接口，供第三方系统在服务端安全调用用户管理、作品查询、数据集查询、嵌入 Ticket 与数据服务等能力。

详细调用步骤请参阅 API 使用说明。

2. 通用响应格式

{
  "code": 0,
  "msg": "操作成功",
  "data": { }
}

code = 0 表示成功；非 0 时 msg 为错误说明。

3. 错误码

错误码HTTP说明
0200成功
40001400参数错误
40101401认证失败（签名错误 / 时间戳过期 / AccessKey 失效）
40301403无权限（如 READ_ONLY 调用写接口）
40401404资源不存在
42901429请求过于频繁
50301503开放 API 已关闭（紧急开关）
50001500服务内部错误

4. 接口目录

方法路径ActionName说明文档
GET/api/open/v1/usersQueryUserList列出用户查看
GET/api/open/v1/users/{userId}QueryUserInfo查询用户详情查看
POST/api/open/v1/usersAddUser新增用户（需 FULL）查看
PUT/api/open/v1/users/{userId}UpdateUser更新用户（需 FULL）查看
DELETE/api/open/v1/users/{userId}DisableUser停用用户（需 FULL）查看
GET/api/open/v1/worksQueryWorks列出已发布作品查看
GET/api/open/v1/works/{worksId}QueryWorksInfo查询作品详情查看
GET/api/open/v1/datasetsQueryDatasetList列出已发布数据集查看
GET/api/open/v1/datasets/{id}QueryDatasetInfo查询数据集详情查看
POST/api/open/v1/datasets/{id}/refreshRefreshDataset刷新数据集（需 FULL）查看
POST/api/open/v1/ticket/createCreateTicket创建嵌入 Ticket查看
GET/api/open/v1/ticket/{ticketId}QueryTicketInfo查询 Ticket 详情查看
DELETE/api/open/v1/ticket/{ticketId}DeleteTicket撤销 Ticket查看
PUT/api/open/v1/ticket/{ticketId}/expireDelayTicketExpire延长 Ticket 有效期查看
POST/api/open/v1/data-service/{apiName}/queryQueryDataService数据服务 POST 取数查看
GET/api/open/v1/data-service/{apiName}/queryQueryDataServiceGet数据服务 GET 取数查看
上一篇开放平台概述下一篇API使用说明