开发指南
简介
我们为具备编程能力的用户提供了一个简单的方法来整合系统数据与任何外部数据。
域名规则
API的统一访问地址获取路径：
- 登录应用主页
工作台，点击右上方个人头像，选择开放平台。- 在
开放平台页面找到API，在API分类中点击应用体系。- 在
应用体系API文档页面中点开任意一个应用，即可在开头介绍分页中看到API的统一访问地址。
| 如图所示： |
|---|
 |
- 所有API请求都必须通过HTTPS进行身份验证和发起；
- 统一采用POST请求的形式；
- 数据传输编码为UTF-8；
- 所有数据均为JSON格式；
频率限制
最多接受请求：5次/秒；
请求认证
系统使用基于简单令牌的身份验证（在 「开放平台」>>「密钥管理」生成或管理您的密钥），API Key默认未生成，需要点击创建API Key生成。
请注意：API Key与您的账户拥有相同的权限，请务必保密。
- 通过 HTTP Headers 设置
Authorization的值为"Bearer YOUR_APIKEY"来进行安全性验证。
示例如下：
$ curl -i API统一访问地址/callback \
-H "Authorization: Bearer YOUR_APIKEY"错误对照表
所有API使用【状态码+错误码】的响应方式来表示错误原因。
接口正确统一返回HTTP状态码为 2xx 的正确响应。
接口错误统一返回HTTP状态码为 400的错误响应，同时响应内容会返回错误码（code）和错误信息（message）。如：
HTTP/1.1 400
Content-Type: application/json
{ "code": 4004,
"message": "超出请求频率限制",
}
- 状态返回码对照表如下：
| 错误码（code） | 说明 |
|---|---|
| 2xx | 响应成功 |
| 400 | 响应失败 |
- 当状态返回码为400时，服务器会返回具体的错误码（code）和错误信息（message），对照表如下：
| 错误码（code） | 说明 |
|---|---|
| 4001 | 接口参数不正确 |
| 4002 | 表单类型不正确 |
| 4003 | 当前套餐不包含此功能 |
| 4004 | 超出请求频率限制 |
| 4005 | 套餐用量超出限制 |
| 4006 | 插入数据失败,后端代码返回错误： |
| 4007 | 图片大小超过套餐内允许的大小 |
| 4008 | 图片上传不成功 |
| 4009 | 聚合表校验失败 |
| 4010 | 数据插入成功,后端代码返回错误： |
| 4011 | 数据不存在 |
| 4012 | 部门不存在 |
| 4013 | 用户不存在 |
| 4014 | 有批量操作进行中，当前操作被拒绝 |
| 4015 | 当前操作只支持团队模式为普通模式 |
| 4016 | 企业内用户ID格式不正确,只能字母,数字,下划线32位内 |
| 4017 | 企业内用户ID已存在 |
| 4018 | 备注格式不正确，32位以内 |
| 4019 | 职称格式不正确，16位以内 |
| 4020 | 姓名格式不正确，只能中文,英文,数字,下划线,(,),-,空格,空格不能在头尾26位以内 |
| 4021 | 部门参数不能为空 |
| 4022 | 站点不允许注册用户 |
| 4023 | 部门名称格式不合法，只能中文,英文,数字,下划线,(,),-,空格,空格不能在头尾16位以内 |
| 4024 | 同级部门下存在同名子部门 |
| 4025 | 父部门不存在 |
| 4026 | 部门编号不合法 |
| 4027 | 部门编号重复 |
| 4028 | 存在子部门的部门不能被删除 |
| 4029 | 存在成员的部门不能被删除 |
| 4030 | 单次导入部门数量超出限制 |
| 4031 | 部门级联层数超出限制 |
| 4032 | 部门关系存在循环 |
| 4033 | 至少需要一个子部门属于根部门 |
| 4034 | 单次导入成员数量超出限制 |
| 4035 | 企业内用户ID重复 |
| 4036 | 注册参数不正确 |
| 4037 | 账号已绑定微信id |
| 4038 | 微信unionid已绑定账号 |
| 4039 | 微信openid已绑定账号 |
| 4040 | 微信unionid格式不合法 |
| 4041 | 微信openid格式不合法 |
| 4042 | 该站点没有开放平台接口权限 |
| 4043 | 用户不属于指定团队 |
| 4044 | 团队不存在 |
| 4045 | 用户不属于指定部门 |
| 4046 | 批量创建数据超过100条限制 |
| 4047 | 管理员不能离职 |
| 4048 | 账号已存在 |
| 5001 | 返回参数不为json格式 |
| 5002 | 执行进程开启失败 |
| 5003 | 获取源文件失败 |
| 5004 | 脚本对象创建失败 |
| 5005 | 读取脚本失败 |
| 5006 | _webapi函数不存在 |
| 5007 | 脚本运行出错 |
| 5008 | 找不到对应的负责人 |
| 5009 | 找不到回退后的负责人 |
| 5010 | 无效的流程数据 |
| 5011 | 找不到流转节点 |
| 5044 | 子流程失败 |
| 6001 | 角色组不存在 |
| 6002 | role_no已存在 |
| 6003 | 角色组创建错误 |
| 6004 | 角色组修改错误 |
| 6005 | 角色组删除错误 |
| 6006 | 添加失败 |
| 7001 | 外部联系人分组不存在 |
| 7002 | 分组名称不符合规则 |
| 7003 | 和已有分组重名 |
| 7004 | 分组重复 |
| 7005 | 默认分组不可删除 |
| 7006 | 分组有成员未删除 |
| 7007 | 外部联系人已存在 |
| 7008 | 修改外部联系人信息异常 |
| 7009 | 用户已在通讯录成员，不能加入外部联系人 |
| 7010 | 外部联系人不存在 |
| 8001 | 企业创建者不能加入任何管理组 |
| 8002 | 管理组名称不符合规则 |
| 8003 | 系统管理员不能移出 |
| 8004 | 已在其他分组 |
| 8005 | 管理组已存在 |
| 9999 | 系统异常，请联系管理员反馈此问题 |
| 10001 | 应用分组创建失败 |
| 10002 | 应用分组重命名失败 |
| 10003 | 应用分组名称不符合规则 |
| 10004 | 应用分组不存在 |
| 10005 | 应用分组删除失败 |
| 10006 | 表单不存在 |
| 11001 | 数据重复 |
| 11002 | 不允许转交 |
| 11003 | 唯一字段对应的数据已存在 |
| 11004 | 请传入数据ID |
| 11005 | 数据不存在 |
| 11006 | 前置事件触发异常 |
| 11007 | 数据助手触发异常 |
| 11008 | 聚合表校验异常 |
| 11009 | 后置事件触发异常 |
| 12001 | 消息发送失败 |
| 12002 | 消息内容错误 |
| 12003 | 未匹配到合法的消息接收者 |
| 13001 | 密钥不存在 |
| 13002 | 当前套餐不包含平台级接口权限 |
| 13003 | 团队信息不正确 |
| 13004 | 赠送失败 |
| 13005 | 账号不存在 |
| 13006 | 应用安装失败 |
| 13007 | 分组中有应用，不能删除 |