1. 简介
简道云的 API 接口包含以下接口：
注：
1）v4 版本及以前的接口文档点击这里：点击查阅。
2）从 v6 版本开始，开放 API 在保证兼容性的情况下，简道云可能会增加（不会减少）相应的出入参数，请开发者考虑参数增加的情况，保证代码的稳定性。如 v6 版本部门接口的更新，添加了seq的入参以及出参，其实不影响 v5 版本的相关逻辑，后续类似处理不会再增加版本。
2. 规则
- API 的统一访问地址为：https://api.jiandaoyun.com/api（非直接访问 URL，结合后文 appid 等一起访问）
- 所有 API 请求都必须通过 HTTPS 进行身份验证和发起
- 统一采用 POST 请求的形式
- 数据传输编码为 UTF-8
- 文件上传接口为 form_data 格式，其他均为 JSON 格式
3. 频率限制
全局最多接受请求：50 次/秒
各个接口的请求频率限制参见各个接口的接口文档：
4. 鉴权方式
简道云使用基于简单令牌的身份验证 ，API KEY 默认未生成，需要点击创建 API KEY 去生成。
生成方式：「开放平台>>密钥管理>>创建 API KEY」；一个企业最多生成 500 个 API KEY。
对于已创建的 API KEY 还可以进行启用、停用和删除。
开发文档中的「API 文档」是专门根据当前表单的配置生成的，可以点开查看详细的说明。
通过 HTTP Headers 设置 Authorization 的值为"Bearer YOUR_APIKEY"来进行安全性验证，
示例如下：
$ curl -i https://jiandaoyun.com/api/v1/callback \
-H "Authorization: Bearer YOUR_APIKEY"5. 代码示例
我们为开发者提供了一些不同语言版本的代码样例，仅供参考：
6. 错误对照表
所有 API 使用状态码+错误码的响应方式来表示错误原因。接口正确统一返回HTTP 状态码为 2xx 的正确响应。接口错误则统一返回 HTTP 状态码为 400 的错误响应，同时响应内容会返回错误码（code）和错误信息（msg）
HTTP/1.1 400
Content-Type: application/json
{
"code": 8303,
"msg": "超出请求频率限制",
}6.1 状态码
状态返回码对照表如下：
状态返回码 | 说明 |
2xx | 响应成功 |
400 | 接口错误统一返回 |
502 | 网关异常 |
579 | 文件上传失败 |
6.2 错误码
当状态返回码为 400 时，服务器会返回具体的错误码（code）和错误信息（msg），对照表如下：
错误码 | 说明 |
1 | 错误的请求 |
1005 | 邮箱已存在 |
1010 | 用户不存在 |
1017 | 用户名不符合格式要求 |
1018 | 用户邮箱不符合格式要求 |
1019 | 用户昵称不符合格式要求 |
1022 | 用户团队不存在 |
1024 | 手机号码不正确，请重新输入手机号 |
1027 | 手机号码已存在 |
1058 | 用户操作权限不足 |
1065 | 当前用户已加入团队 |
1082 | 手机号和邮箱不能同时为空 |
1085 | 昵称不能为空 |
1087 | 唯一性字段重复 |
1092 | 工号长度超出限制 |
1096 | 用户参数不合法，请检查后重试 |
1201 | 企业角色信息不存在 |
1202 | 无法操作同步的角色/角色组 |
1203 | 角色/角色组信息不合法 |
1205 | 必须指定角色组 |
1206 | 指定的角色组不存在 |
1207 | 角色/角色组名称长度超限 |
1208 | 非空角色组不能删除 |
2004 | 应用不存在 |
3000 | 表单不存在 |
3001 | 名称不能为空 |
3005 | 参数不正确 |
3041 | 单个表单流水号控件数量超出上限 |
3042 | 字段别名校验失败 |
3083 | 控件数量超过上限 |
3091 | 表单名称不能超过 100 个字符 |
3092 | 标题不能超过 100 个字符 |
4000 | 数据提交失败 |
4001 | 数据不存在 |
4007 | 操作失败，没有流程处理人 |
4008 | 操作失败，流程已经关闭 |
4009 | 操作失败，无权限 |
4015 | 操作失败，当前节点不存在该候选人 |
4016 | 操作失败，流程不能转交给自己 |
4025 | 您没有数据流程权限 |
4042 | 数据删除失败 |
4402 | 聚合计算校验失败 |
4815 | 过滤条件设置有误 |
5003 | 流程节点不存在 |
5004 | 未提交流程审批意见 |
5009 | 找不到回退后的负责人 |
5011 | 找不到流转节点 |
5012 | 未提交流程手写签名 |
5034 | 目标节点包含子流程/插件节点 |
5044 | 子流程配置错误或找不到发起人 |
5045 | 发起子流程数据超过上限 200 |
5049 | 当前流程节点未开启转交 |
5053 | 流入多级主管审批节点失败，未指定发起部门 |
6000 | 已存在同名部门 |
6001 | 父部门不存在 |
6002 | 部门不存在 |
6003 | 存在子部门，不能删除 |
6004 | 部门修改失败 |
6005 | 部门创建失败 |
6006 | 部门内存在成员，不能删除 |
6010 | 部门编号不在合法范围内 |
6011 | 部门关系存在循环 |
6012 | 部门名称不合法 |
6013 | 部门编号重复 |
6014 | 至少需要一个子部门属于根部门 |
6015 | 根部门不能被删除 |
6017 | 部门级联层数超出限制 |
6019 | 成员列表不能为空 |
6020 | 单次导入部门数量超出限制 |
6021 | 单次导入成员数量超出限制 |
6064 | 已是目标部门的子部门 |
7103 | 系统用量超出限制，系统已暂停使用。您可以至「企业管理-版本信息」查看版本使用详情和升级版本以恢复系统。 |
7212 | 该账号的本月数据流量已用完，无法提交新数据，请联系账号创建者升级版本。 |
7216 | 附件上传量超过当前版本限制，请联系连接发布者开启云币支付。 |
7217 | 附件上传量超过当前版本限制，请联系企业创建者开启云币支付。 |
7218 | 附件上传量超过当前版本限制，请联系连接发布者充值云币。 |
7219 | 附件上传量超过当前版本限制，请联系企业创建者充值云币。 |
8017 | 企业不存在或者已经被解散 |
8301 | API 签名校验失败 |
8302 | 没有接口请求权限 |
8303 | 企业API请求次数达到频率上限 |
9004 | 队列任务创建失败 |
9007 | 锁获取失败 |
17017 | 平台 API 的参数异常 |
17018 | 无效的 API Key |
17023 | 单次批量修改数量超出限制 |
17024 | 单次批量创建数量超出限制 |
17025 | transaction_id 参数格式不正确 |
17026 | transaction_id 重复，请修改后重试 |
17027 | API文件上传失败 |
17032 | 不支持的字段类型 |
17034 | 不支持的子表单字段类型 |
30002 | CRM 预设表单暂不支持调用 |
50000 | 目标节点不存在 |
50004 | 待办任务不存在 |
50008 | 流转异常 |
50011 | 执行实例不存在 |
50014 | 操作人不能为空 |
50016 | 流程实例不存在 |
50019 | 不支持的审批行为 |
50021 | 关联业务对象不存在 |
50031 | 流程数据不存在 |
50040 | 当前节点禁止回退 |
50041 | 回退节点为当前节点 |
50047 | 流程迁移中，请稍后再试 |
50049 | 不允许回退到没有创建者的发起节点 |
50051 | 流程已被处理，请刷新后查看 |
50053 | 加签候选人列表不能为空 |
50054 | 不支持嵌套加签 |
50055 | 不支持该类型任务处理 |
50056 | 加签父任务丢失 |
50057 | 加签配置未开启 |
50059 | 加签候选人不能选择节点负责人 |
50060 | 加签候选人非法 |
50061 | 不支持多人加签 |
50062 | 待被加签人处理中 |
50070 | 不允许回退到插件节点 |
50073 | 禁止回退到进行中节点 |
400-111-0890
在线咨询