jdy
    jdy
    • 开发指南
    • app
      • 用户应用查询接口
        POST
      • 用户表单查询接口
        POST
    • formdata
      • form
        • 表单字段查询接口V5
      • data
        • 查询单条数据接口
        • 查询多条数据接口
        • 新建单条数据接口
        • 新建多条数据接口
        • 修改单条数据接口
        • 修改多条数据接口
        • 删除单条数据接口
        • 删除多条数据接口
    • file
      • 获取文件上传凭证和上传地址接口
        POST
      • 文件上传接口
        POST
    • corp
      • user
        • 获取成员信息接口
        • 添加成员接口
        • 修改成员接口
        • 删除成员接口
        • 批量删除成员接口
        • 增量导入成员接口
      • department
        • (递归)获取部门成员接口
        • (递归)获取部门列表接口
        • 创建部门接口
        • 修改部门接口
        • 删除部门接口
        • 获取集成模式部门编号接口
        • 全量导入部门接口
      • role
        • 列出角色接口
        • 创建一个自建角色
        • 更新一个自建角色
        • 删除一个自建角色
        • 列出角色下的成员
        • 为自建角色批量添加成员
        • 为自建角色批量移除成员
      • role_group
        • 列出自建角色组
        • 创建自建角色组
        • 更新自建角色组
        • 删除自建角色组
      • guest
        • 列出我连接的企业
        • 列出我连接的企业的对接人
        • 获取我连接的企业对接人的详细信息
    • workflow
      • 获取单条流程表单数据的审批意见
        POST
      • 查询流程实例信息
        POST
      • 结束流程实例
        POST
      • 流程待办查询
        POST
      • 流程待办提交
        POST
      • 流程待办回退
        POST
      • 流程待办转交
        POST
      • 查询流程日志
        POST
      • 激活流程实例
        POST

    开发指南

    1. 简介#

    简道云的 API 接口包含以下接口:
    应用接口
    表单&数据接口
    文件接口
    流程接口
    通讯录接口
    注:v4 版本及以前的接口文档点击这里:点击查阅。

    2. 规则#

    API 的统一访问地址为:https://api.jiandaoyun.com/api(非直接访问 URL,结合后文 appid 等一起访问)
    所有 API 请求都必须通过 HTTPS 进行身份验证和发起
    统一采用 POST 请求的形式
    数据传输编码为 UTF-8
    文件上传接口为 form_data 格式,其他均为 JSON 格式
    img
    img

    3. 频率限制#

    全局最多接受请求:50 次/秒
    各个接口的请求频率限制参见各个接口的接口文档:
    应用接口
    表单&数据接口
    文件接口
    流程接口
    通讯录接口

    4. 鉴权方式#

    简道云使用基于简单令牌的身份验证 ,API KEY 默认未生成,需要点击创建 API KEY 去生成。
    生成方式:「开放平台>>密钥管理>>创建 API KEY」;一个企业最多生成 2 对 API KEY。
    img
    对于已创建的 API KEY 还可以进行启用、停用和删除。
    img
    开发文档中的「API 文档」是专门根据当前表单的配置生成的,可以点开查看详细的说明。
    查看方式:「开放平台 >> 开发文档 >> API 文档」。
    img
    通过 HTTP Headers 设置 Authorization 的值为"Bearer YOUR_APIKEY"来进行安全性验证,
    示例如下:
    $ curl -i https://jiandaoyun.com/api/v1/callback \
      -H "Authorization: Bearer YOUR_APIKEY"

    5. 代码示例#

    我们为开发者提供了一些不同语言版本的代码样例,仅供参考:
    python
    C#
    go
    java
    node

    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),对照表如下:
    错误码说明
    1010用户不存在
    1017成员编号格式不合法
    1019成员昵称长度超出限制
    1024手机号码不正确
    1085成员昵称不能为空
    1087唯一性字段重复
    1096请求参数不合法
    3001成员/部门名不能为空
    3005接口参数不正确
    4000数据提交失败
    4001数据不存在
    4402聚合计算校验失败
    6000同级部门下存在同名子部门
    6001父部门不存在
    6002部门不存在
    6003存在子部门的部门不能被删除
    6004部门修改失败
    6005部门创建失败
    6006存在成员的部门不能被删除
    6010部门编号不合法
    6011部门关系存在循环
    6012部门名称格式不合法
    6013部门编号重复
    6014至少需要一个子部门属于根部门
    6015不允许删除根部门
    6017部门级联层数超出限制
    6020单次导入部门数量超出限制
    6021单次导入成员数量超出限制
    7103系统超出用量(数据总量、单表数据量)
    8017企业不存在
    8301签名校验失败
    8302没有接口请求权限
    8303企业API请求次数达到频率上限
    8304当前API请求次数达到频率上限
    9007锁获取失败
    17018无效的 API Key
    17025transaction_id 参数格式不正确
    17026transaction_id 重复,请修改后重试
    30002CRM 预设表单暂不支持调用
    下一页
    app
    Built with