开发前必读
概述
开发者使用指南
开发者使用流程
通信说明
开发者工具
更新日志
基础能力接口
获取token接口
外部系统单点登录
单点登录使用说明
获取单点登录用户信息
通讯录管理
获取部门列表
新增部门
修改部门
删除部门
新增用户
修改用户
删除用户
获取用户列表
通讯录变更同步
获取标签信息
新增标签
修改标签
删除标签
获取标签成员列表
添加标签成员
删除标签成员
按部门查询标签
按用户查询标签
离职用户
获取离职信息
用户复职
获取自定列表信息
第三方消息推送
推送文本消息
推送图文消息
推送消息附录
统一消息推送(回调)
图片附件上传
图片附件下载
图片附件单个下载
图片附件批量下载
应用数据接口
表单流程/七巧
新增表单
获取表单模板信息
推送数据
修改表单数据
删除表单数据
数据源
数据回调
导出表单流程数据
获取填写情况详细数据(新)
通过ID获取填写详细数据(新)
流程干预
获取填写情况详细数据(旧)
通过ID获取填写详细数据(旧)
获取应用填写详细数据(待办、已办等)
发票识别接口
发票验真接口
附录
考勤打卡
获取考勤规则列表
获取考勤详细信息
获取考勤日报信息
注册考勤服务
新增虚拟考勤机
删除虚拟考勤机
考勤机打卡
获取考勤排班明细
获取考勤异常申诉记录
请假出差
获取请假信息列表
获取请假类型列表
假期管理
获取请假详情信息
新闻公告
获取新闻动态类型
新增新闻动态
获取新闻列表
获取新闻详情
获取个人新闻列表
费控报销
获取报销信息列表
获取成本中心信息列表
导入成本中心
获取预算明细
获取发票信息列表
获取借款信息列表
获取用户可见范围内成本中心
获取用户可见范围内科目
获取超额预算
费控预算操作
企业用车
获取车辆申请列表
任务分派
获取任务分派信息列表
获取任务类型信息接口
新建任务接口
移动CRM
获取客户信息列表
获取客户字段
新增客户
更新客户
获取客户详情
获取客户类别
获取所有公海池
获取所有行业信息
获取联系人信息列表
获取联系人字段
新增联系人
更新联系人
获取联系人详情
获取商机信息列表
获取商机字段
新增商机
更新商机
获取商机详情
获取商机阶段或商机类型
修改商机阶段
获取拜访信息列表
获取合同信息列表
获取合同字段
新增合同
更新合同
获取合同详情
获取公海池客户信息列表
获取公海池客户详情
培训考试
获取考试成绩列表
获取考试统计信息列表
获取考试人员明细
获取学习统计信息列表
获取个人学习档案信息列表
获取课程统计信息列表
获取课程人员明细
获取个人学分明细
获取讲师信息列表
获取题库试题明细
新增题库试题
删除题库试题
移动外勤
获取签到信息列表
会议管家
获取会议详情
获取会议纪要详情
获取会议室详情
获取区域列表
获取会议室列表
获取会议详情列表

通信说明

开发说明

通讯流程




通信步骤


请求方根据平台提供的URL,HTTPS POST方式提交请求, 平台接到请求后处理请求,以json格式的形式返回处理结果。

请求方接收平台json格式的回复报文,并对该报文进行解析。

用例结束。


请求方式


云平台所有需要传递unicode字符的接口采用文件传输方式POST(HTTPS)multipart/form-data,字符编码集采用UTF-8

接口文档如无特殊说明,unicode字符使用json传递,json的请求参数为data

示例:


回调流程



回调通信步骤


云平台根据用户在开发者账号填写的回调地址,HTTPS POSTGET 方式提交请求。

必备的参数有:

1,type,为了能让外部系统区分业务,云平台会加上type参数给外部系统用于区分是从什么功能模块回调的。

参数的可选值如下表:

type参数 回调功能模块
FORM_CALLBACK 表单流程数据回调接口
SEND_MESSAGE 统一消息推送

2,timestamp,为了给外部系统校验请求对的及时性,云平台加上从北京时间1970年1月1日上午八点整到现在的毫秒数。

外部系统可以根据情况与自身系统时间比对,酌情加上5~15分钟的延迟宽限。


3,请求头(http-header)参数:authCode,为了给外部系统提供云平台请求的防篡改校验,云平台会在对所有POST参数组合成按key的alpha-beta排序的json(如果不存在任何post参数,则json为花括号对“{}”),以开发者信息中的凭证密钥(developerKey)作为key,进行hmac-md5 hash,把结果值以请求头authCode,传递给外部系统。
例如:云平台请求回调地址为

POST :http://www.domain.com.cn/callbackapi

POST参数:

type=FORM_CALLBACK

timestamp=1688001938000

id=A

data=B


开发者信息中凭证密钥:C

则hash函数的参数为:{"data":"B","id":"A","timestamp":"1688001938000","type":"FORM_CALLBACK"}

得到authCode为:new HMACMD5("C").hash("{\"data\":\"B\",\"id\":\"A\",\"timestamp\":\"1688001938000\",\"type\":\"FORM_CALLBACK\"}")=

671c1c9725b88c36e3a154c783afbc0f


外部系统接到请求后处理请求:

1,对请求参数中的时间戳 (timestamp)进行及时性校验。

2,对POST参数与请求端同样的方式进行hmac-md5 hash,获取到的结果与请求头authCode的值进行比对,值相同才认为是合法的请求。

3,以json格式的形式返回处理结果。

请求方接收平台json格式的回复报文,并对该报文进行解析。

用例结束。