接口更新记录
2024-01-19
1)新增查询流程日志接口
新增 查询流程日志接口,用于获取单条表单数据的流程日志信息,包括:待办任务的开始时间、审批时间、审批意见内容、附件列表以及涉及的审批人等。如下图所示:
注:目前仅支持返回包含审批意见的流程日志。
2)添加成员接口新增部门校验
在使用 添加成员接口 为指定部门添加成员时,将对输入的部门列表进行存在性校验,若列表中有不存在的部门,则添加成员失败,并返回不存在的部门编号信息,便于及时调整。如下图所示:
2023-12-01
本次更新后,查询流程实例信息接口 和 流程待办查询接口 更新至 V5 版本,新增 2 个响应参数:
- tasks[].create_action:创建待办的流程动作
- tasks[].finish_action:完成待办的流程动作
2023-10-11
1)列出角色下的成员接口更新
本次更新后,列出角色下的成员接口新增如下请求参数和响应参数:
- 新增请求参数
- has_manage_range:是否返回分管部门信息
- 新增响应参数
- departments_range:角色分管部门编号数组
- has_child:是否包含子部门
参数配置详情参见:角色接口。
注:仅有配置了分管部门的成员才会显示 departments_range 和 has_child 这两个响应参数。
2023-09-19
1)流程待办查询接口
本次更新后,流程待办查询接口更新至 V4 版本,新增 3 个响应参数:
- tasks[].create_time:待办开始时间
- tasks[].finish_time:待办结束时间
- tasks[].status:待办状态
参数配置详情参见:流程待办查询。
2)查询流程实例信息接口
本次更新后,查询流程实例信息接口更新至 V4 版本,新增如下请求参数和响应参数:
- 新增请求参数
- tasks_type:返回待办种类
- 新增响应参数
- finish_time:结束时间
- tasks[].title:待办名称
- tasks[].create_time:待办开始时间
- tasks[].finish_time:待办结束时间
- tasks[].status:待办状态
参数配置详情参见:查询流程实例信息。
2023-09-01
1)官方 6 款插件价格调整
本次更新中,我们对以下 6 款插件进行了降价调整,具体为:
- 身份证姓名二元验证:原 0.25 元/次降为 0.1 元/次,降价幅度 60%
- 插件介绍:校验姓名和身份证号的真实性和一致性,可应用于活动登记、访客登记、应聘登记、会议签到等场景,确保登记信息的真实性,提高运营的效率。
- 安装链接:身份证姓名二元验证
- 银行卡姓名二/三/四元验证:原 0.4 元/次降为 0.3 元/次,降价幅度 25%
- 插件介绍:校验姓名、身份证号、手机号码和银行卡号的真实性和一致性。可应用于入职登记、付款申请、费用报销等场景,确保收款信息的准确性,提高转账的成功率。
- 安装链接:
- 手机号姓名二/三元验证:原 0.6 元/次降为 0.3 元/次,降价幅度 50%
2)页面弹窗插件支持在新标签页打开
页面弹窗插件 支持配置 URL 的打开方式为「弹窗弹出URL」还是为「新标签页打开」。如下图所示:
新标签页打开的效果如下图所示:
3)自建插件前端函数新增 2 个 API
自建插件 前端扩展函数新增以下 2 个 API:
- $g.utils.openUrl :新标签页打开 URL
- $g.ui.onmessage:接收弹窗 iframe 内发送的消息
4)数据提交 API 支持指定数据提交人
数据提交 API 「新建单条数据接口」、「新建多条数据接口」中的请求参数增加 data_creator(成员编号,即 username) 。通过 data_creator 参数,可以自定义传入数据的提交人信息。以 新建单条数据接口 为例:
请求示例:
{
"app_id":"62df48866268a800069ce128",
"entry_id":"64eeb36f0995460007a9be37",
"data_creator":"jdy",
"data":{
"_widget_1693300060295":{
"value":"简道云"
},
"_widget_1693300060299":{
"value":"小简"
},
"_widget_1693300060298":{
"value":"18861838888"
}
}
}
响应示例:
{
"data": {
"creator": {
"name": "夏洛",
"username": "jdy",
"status": 1,
"type": 0,
"departments": [
159
]
},
"updater": {
"name": "夏洛",
"username": "jdy",
"status": 1,
"type": 0,
"departments": [
159
]
},
"deleter": null,
"createTime": "2023-08-30T03:26:18.190Z",
"updateTime": "2023-08-30T03:26:18.190Z",
"deleteTime": null,
"_widget_1693300060295": "简道云",
"_widget_1693300060299": "小简",
"_widget_1693300060298": "18861838888",
"_id": "64eeb6da3218930007341745",
"appId": "62df48866268a800069ce128",
"entryId": "64eeb36f0995460007a9be37"
}
}
数据效果:
2023-08-02
1)新增流程相关接口如下:
注:新增的流程接口仅支持在新版流程中使用。
2)如下部门接口更新至 V6 版本,支持进行部门排序。详情参见:部门接口。
- (递归)获取部门列表
- 创建部门
- 修改部门
- 获取集成模式部门编号
2023-05-25
开放平台的密钥管理处,新增 API调用日志 的查询功能,用户可以根据接口名称、API Key 名称以及调用时间查询近 7 天接口调用情况。如下图所示:
注:API 调用日志仅保留 7 天。
2023-05-10
API Key 新增应用授权范围和接口授权范围,企业可以对接口实现更精细化的管理需求:
点击详情可以设置具体需要授权的应用或接口:
2023-04-18
查询流程实例信息 接口更新至 V3 版本,新增如下响应参数:
- url:实例访问链接;
- tasks[].app_id:应用 id
- tasks[].form_id:表单 id;
- tasks[].form_title:表单名称;
- tasks[].instance_id:实例 id;
- tasks[].task_id:待办 id;
- tasks[].url:待办访问链接;
- tasks[].creator:实例创建者信息。
2023-03-17
流程待办查询接口 响应参数新增 flow_id、flow_name。
2023-03-02
流程待办查询接口 调整部分参数名:
- 新增应用 id: tasks[].app_id ;
- 新增表单 id:tasks[].form_id;
- 调整 tasks[].task_id 名称为待办 id。
2022-10-28
1)接口版本及频率调整:已有接口全部更新至 V5 版本,V5 版本中提升了接口调用频率,如果对频率有更高要求,可迁移到新版上。V5 版本接口调用频率如下表:
接口 | 接口调用频率(次/秒) |
单条/多条数据/表单字段查询接口 | 30 |
待办查询/查询流程实例信息/单条表单流程数据的审批意见 | 30 |
应用/表单/角色/角色组/角色下所有成员列表 | 30 |
获取成员 | 30 |
列出我连接的企业相关接口 | 30 |
根据集成模式通讯录的部门 ID 获取部门编号 | 30 |
新建/修改/删除单条数据接口 | 20 |
获取文件上传凭证和上传地址接口 | 20 |
待办提交/回退/转交/结束流程实例 | 20 |
创建/更新/删除成员/部门/角色/自建角色组 | 20 |
新建/修改/删除多条数据接口 | 10 |
获取部门列表/部门成员 | 10 |
批量导入部门/成员/删除成员 | 10 |
为自建角色批量添加/移除成员 | 10 |
注:全局接口调用频率限制为 50 次/秒。
2)接口请求路径及请求参数调整:请求路径中含 appid、entryid、username 等参数的,参数全部放入 body 中;
3)通讯录接口的所有请求路径中新增 corp。如,添加成员接口由 POST-user/create 优化为 POST-corp/user/create;
各个接口的变动详情参见文档:API。
4)新增流程相关接口,具体如下:
- 查询流程实例信息
- 结束流程实例
- 流程待办查询
- 流程待办提交
- 流程待办回退
- 流程待办转交
参数配置详情参见:流程接口。
注:新增的流程接口目前仅支持在新版流程中使用。
2022-06-30
通讯录接口 中, V2 版本的接口升级到 V4 版本。其他更新内容如下所示:
3)获取集成模式部门编号接口请求地址变更为:https://api.jiandaoyun.com/api/v4/department/get_dept_by_integrateid。
2022-06-14
1)API demo 示例代码更新,详情参见:表单&数据接口。
2)新增「删除多条数据接口」,通过该接口可以批量删除表单中的数据。详情参见:删除多条数据接口。
2022-04-21
1)新增企业互联接口如下:
- 列出我连接的企业
- 列出我连接的企业的对接人
- 获取我连接的企业对接人的详细信息
参数配置详情参见:企业互联接口。
2)部分数据 API 新增 V4 版本,V4 版本中的部门单选/多选、成员单选/多选字段,新增 type 字段,用以标记内/外部组织。涉及接口如下:
注:本次更新后,新建 Webhook 推送的数据将使用 V4 数据结构,此改动会导致使用老 API 新 Webhook,或新 API 老 Webhook 时, 推送的结构和接口返回值的结构不一致。如果使用新 API 或 Webhook,需要把两者一起更新,同步使用新 API 及 Webhook。其他之前的 Webhook 不受影响。
3)API时间格式限制
通过 API 写入时间类型的数据时,需严格按照简道云支持的时间格式写入。详情参见文档 表单&数据接口 中【3.3节】。
2022-04-08
新增通讯录角色接口如下:
1)角色:
- 列出角色
- 创建一个自建角色
- 更新一个自建角色
- 删除一个自建角色
- 列出角色下的成员
- 为自建角色批量添加成员
- 为自建角色批量移除成员
2)角色组:
- 列出自建角色组
- 创建自建角色组
- 更新自建角色组
- 删除自建角色组
参数配置详情参见:角色接口。
2021-12-30
新增「文件接口」、「新建多条数据接口」以及「更新多条数据接口」。点击查看详情:
2021-10-26
表单API 新增「表单字段查询接口V2」,V2 在 V1 的基础之上新增了系统字段及表单数据修改时间的获取。详细使用方式参见文档:表单&数据接口。
2021-06-01
1)微信支持接口推送
微信增强 中的三个字段支持API和webhook,分别是:
- 微信OpenID
- 用户昵称
- 用户性别
支持的场景有:
- 查询多条数据接口
- 查询单条数据接口
- webhook数据推送
2)新增两个接口
新增两个接口:
- 应用查询接口:POST - /api/v1/app/retrieve_all
- 表单查询接口:POST - /api/v1/app/{app_id}/entry_retrieve
通过这两个接口可以分别获取当前用户下的所有应用信息和表单信息,详情参考文档:应用接口。
2021-05-14
简道云通讯录接口新增「根据集成模式通讯录的部门 ID 获取部门编号」,新增的接口仅支持集成模式,公共模式暂不支持。
新增接口如下:
POST /api/v2/department/get_deptno_by_integrateid - 根据集成模式通讯录的部门ID获取部门编号
由于企业微信/钉钉与简道云通讯录的当前部门规则一致,并不一定需要使用此接口;而飞书平台的部门 ID 是由字符串组成,因此与简道云通讯录的部门 ID 不一致,需要使用此接口。
详情参见:通讯录接口-部门管理
2021-03-31
子表单新增数据 ID 参数,即为子表单中每条子数据新增一个数据 ID(以下简称数据 ID)。该变动将于 2021 年 3 月 31 日上线,请应用了相关接口用户注意以下调整。具体涉及的改动点:
- Webhook
- 2021-03-31 00:00:00 后创建的 Webhook 在推送数据时,数据结构中新增子表单数据ID;
- 2021-03-31 00:00:00 前创建的 Webhook 推送的数据不发生变化(不过后续也有计划对这部分 Webhook 进行改造,请各位用户尽早调整)
- API
- API 查询单条数据接口新增 v2 版本,v2 版本返回数据新增子表单数据 ID
- API 查询多条数据接口新增 v2 版本,v2 版本返回数据新增子表单数据 ID
- API 新建单条数据接口新增 v3 版本,v3 版本返回数据新增子表单数据 ID
- API 修改单条数据接口新增 v3 版本,v3 版本请求数据新增子表单数据 ID,返回数据也新增子表单数据 ID
详情参见: 2021-03-31接口变动说明
2021-03-16
1.本次迭代后,「老关联数据」仍推送「key+数据id」,「新关联数据」仅推送「数据id」。
2.「老关联数据」兼容为「新关联数据」后,「字段id」不变,仅推送「数据id」。
详情参见: 2021-03-16更新详解
2021-02-02
1.调整API和webhook中「成员单选」、「成员多选」、「提交人」、「修改人」、「删除人」对应的返回结构,新增 status 属性;
2.status 属性分别对应的逻辑为:
- -1 代表离职;
- 0 代表未加入;
- 1 代表已加入。
详情参见: 2021-02-02更新详解
2020-07-07
1. 新增分批获取单条流程表单数据审批意见的接口。
2. API和数据推送的附件链接有效期延长至15天。
详情参见:2020-07-07 更新详解