1. 概述
1.1 登录认证
本页面所有接口均需要临时令牌。请先使用您的 accessKeyId 和 accessKeySecret 获取，详见 登录认证。
访问接口时在设置中将 Value 替换为您的临时令牌。
1.2 CSV 文件说明
1）数据的格式采用 csv 文件存储，格式如下：
假设文件名为 data.csv，其内容为（其中第一行是表头，第一行之后是表数据）；
表头行字段中可以将字段类型（目前支持字符串文本string、日期或时间date、数字类型number（不区分大小写））写在字段后，用#分隔，不带类型则默认为文本；
主键字段在末尾添加#key（不区分大小写），可与字段类型连用。（主键唯一，多主键可以自行拼接成一个新的主键。）
"合同签约时间(Year Month Day)#date","城市","国家","客户名称#string#key","省份","回款金额","合同金额"
"18/1/2016","杭州市","中国","浙江臻善科技有限公司","浙江省","1200000","1200000"
"1/8/2016","郑州市","中国","杭州明佑电子有限公司","河南省","100800","100800"
"1/4/2016","西安市","中国","西北工业大学","陕西省","430000","430000"
2）csv 文件需要使用 utf-8 编码，其他编码均无法正确解析。
3）为了避免数据中的逗号和 csv 的分隔符冲突，我们要求所有的数据均要使用双引号包含起来。
4）数据中可能含有换行符的，转换数据时需要全局处理类似符号，否则可能导致格式错误。
5）数据中可能含有英文引号的，注意不要和数据的引号冲突。
6） 当前默认为全量覆盖表数据，如需切换到增量更新，参考 4.4 节接口 /api/v1/datasource/table/modify。
2. 开启API数据源
接口简介：
| 接口作用 | 开启API数据源 |
| 接口URL | /api/v1/datasource/status/modify |
| 请求参数 | {"status":"1"} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/status/modify |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
开启后，可在数据连接市场看到 API 数据源入口。如下图所示：
3. 分组管理
3.1 创建分组
接口简介：
| 接口作用 | 创建分组 |
| 接口URL | /api/v1/datasource/group/create |
| 请求参数 | {"groupName":"#分组名"} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/group/create |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": "c65201928c874a41bdb7ee199b2684db", "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
3.2 读取所有分组
接口简介：
| 接口作用 | 读取所有分组 |
| 接口URL | /api/v1/datasource/group/list |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/group/list |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [ { "id": "34e7e1bee25e42c8a7e48cb6096c9ec5", "name": "API测试" }, { "id": "c65201928c874a41bdb7ee199b2684db", "name": "API 数据表" } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
3.3 读取分组下的所有表
接口简介：
| 接口作用 | 读取分组下的所有表 |
| 接口URL | /api/v1/datasource/group/table/list |
| 请求参数 | {"groupId":"#分组Id"} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/group/table/list |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [ { "id": "d38dd9f6ead140648535275496a4177c", "name": "销售数据表" } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
3.4 修改分组名
接口简介：
| 接口作用 | 修改分组名 |
| 接口URL | /api/v1/datasource/group/modify |
| 请求参数 | {"groupId":"#分组Id","groupName":"#新的分组名"} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/group/modify |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
3.5 删除分组
接口简介：
| 接口作用 | 删除分组(分组下有表存在时无法删除) |
| 接口URL | /api/v1/datasource/group/delete |
| 请求参数 | {"groupId":"#分组Id"} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/group/delete |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
4. 表管理
4.1 创建数据源表
接口简介：
| 接口作用 | 创建数据源表 |
| 接口URL | /api/v1/datasource/table/create |
| 请求参数 | {"tableName":"#表名","groupId":"#分组Id","updateMode":1（可选1,2,3或不上传默认为1）} |
| 请求类型 | POST |
| 备注 | updateMode: 更新方式 1：全量更新:用全新的数据替换旧的全部数据（数据可以做到新增、修改、删除，但是耗费资源较多，表数据量大时可能会比较慢，表数据量小时推荐使用，每次替换大规模数据时推荐使用）； 2：增量更新:新增新数据，旧数据不受影响（数据无法更新、删除，只能新增，记录历史数据无需修改和删除时推荐使用，效率最高）； 3：替换更新:（必须声明主键）按主键替换相同主键的数据，之前没有的数据直接新增。（主键处理见csv文件说明）（数据只能替换、新增，不能删除，每次更新会修改少量数据时推荐使用） |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/table/create |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": "18c5c6d790364b9091be37b45ed52372", "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
4.2 获取表数据上传地址
接口简介：
| 接口作用 | 获取表数据上传地址 |
| 接口URL | /api/v1/datasource/table/upload/url |
| 请求参数 | {"tableId":"#表Id"} |
| 请求类型 | POST |
| 说明 |
|
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/table/upload/url |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": "https://qfx30.oss-cn-hangzhou.aliyuncs.com/qfx3/sync/18c5c6d790364b9091be37b45ed52372.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241231T023734Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=LTAI4GKmR7rpd5thHtVrBHpv%2F20241231%2Foss-cn-hangzhou.aliyuncs.com%2Fs3%2Faws4_request&X-Amz-Signature=b6b18bde22722d2b53f84d75684990c38d30faf0607a9e37aa8b16a2958676ff", "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
4.3 标记表数据已上传完成
接口简介：
| 接口作用 | 标记表数据已上传完成 |
| 接口URL | /api/v1/datasource/table/upload/finish |
| 请求参数 | {"tableId":"#表Id"} |
| 请求类型 | POST |
| 说明 | 创建表的动作是异步处理的，因此有可能存在调用标记数据上传完成接口时表未创建完成的情况，推荐在调用前等待3秒 |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/table/upload/finish |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": "18c5c6d790364b9091be37b45ed52372", "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
4.4 修改数据源表名、更新方式
接口简介：
| 接口作用 | 修改数据源表名、更新方式 |
| 接口URL | /api/v1/datasource/table/modify |
| 请求参数 | {"tableId":"#表Id","tableName":"#新的表名","updateMode": 1（可选1,2,3或不上传默认为1，说明见本文 4.1 节)} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/table/modify |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
4.5 删除数据源表
接口简介：
| 接口作用 | 删除数据源表 |
| 接口URL | /api/v1/datasource/table/delete |
| 请求参数 | {"tableId":"#表Id"} |
| 请求类型 | POST |
响应实例：
| 请求示例 | https://work.jiushuyun.com/decision/api/v1/datasource/table/delete |
| 响应成功 | { "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null } |
| 截图示例 |
|
4.6 重置整个数据源
接口简介：
| 接口作用 | 重置整个数据源 |
| 接口URL | /api/v1/datasource/reset |
| 请求类型 | POST |
