会员


会员中心
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询field为value的search字段值。如需查询已登录用户自己的所有信息,可不传任何参数(search默认为my)。如需根据guid查询username:search填'username',field填'guid',value填'用户名'
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
search string 查询结果:默认为my,即已登录用户的所有信息,支持all(任意用户所有信息)/username/email/mobile/avatar/loginip/jointime等
field string 查询条件字段:默认guid,支持guid/username/mobile/email/id
value string 查询条件判断值,与field组合进行条件判断查询
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
生成用户密码
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
user_guid string 用户guid
password string 密码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
第三方账号解绑
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
openid string 用户openid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
用户不存在则新建
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
openid string 用户openid
mobile string 手机号
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
第三方账号绑定用户中心
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
openid string 用户openid
account string 用户名/邮箱/手机
password string 密码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
openid用户不存在则新建,用户存在但手机不同则换绑
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
code string 手机号快速验证Code码
openid string 用户openid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
第三方获取用户手机
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
code string 手机号快速验证Code码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
第三方获取用户授权信息
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
openid string 用户openid
detail string 微信参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
第三方登录
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
code string Code码
pid string 上级用户UID,默认为0
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询登录用户的行为日志
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
type string 行为类型,不传默认返回全部(login_success:登录成功)
staff_id string 员工ID
limit integer 每页数量,默认10
page integer 页码,默认1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询登录用户权限
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
会员登录
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
account string 账号
password string 密码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
设置或修改密码
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
oldpassword string 旧密码,手机注册新用户不传
newpassword string 新密码
renewpassword string 重复新密码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
用户是否设置过密码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
account string 账号(可使用账号,用户名,邮箱,手机号)
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
重置密码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
email string 邮箱
type string 类型:mobile|email
newpassword string 新密码
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改手机号
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
mobile string 手机号
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改邮箱
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
email string 邮箱
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改会员个人信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
avatar string 头像地址,先调用common/upload接口上传图片
username string 用户名
nickname string 昵称
bio string 个人简介
gender string 性别:0未知,1男,2女
birthday string 生日:格式1999-09-09
realname string 用户实名
license_type string 身份证件类型(1居民身份证2港澳通行证3台湾通行证4护照)
license_no string 身份证件号码
bank_name string 开户行
bank_account string 银行卡号
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注销登录
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注册会员
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
username string 用户名
password string 密码
email string 邮箱
mobile string 手机号
code string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
手机验证码登录
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(不传则获取默认登录企业)
参数
名称 类型 必选 描述 示例
mobile string 手机号
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
向指定用户发送点对点消息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
uid string 接收消息的用户uid
msg string 消息内容
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

Token


检测Token是否过期
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
原Token失效,替换为新Token再进行后续操作
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

验证


检测邮箱
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
email string 邮箱
id string 排除会员ID
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测用户名
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
username string 用户名
id string 排除会员ID
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测手机号是否占用
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
id string 排除会员ID
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测手机号是否存在
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测邮箱
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 邮箱
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测手机验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
captcha string 验证码
event string 事件
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测邮箱验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
email string 邮箱
captcha string 验证码
event string 事件
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

手机短信


同一个签名,对同一个手机号的发送频率:1分钟内短信发送条数不超过1条,1小时内短信发送条数不超过5条,1个自然日内短信发送条数不超过10条
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
event string 事件名称:register注册/mobilelogin手机登录(自动注册)/changemobile修改手机/resetpwd修改密码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
event string 事件名称
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
发送通知短信
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号,多个用英文逗号隔开,上限1000个
event string 事件名称:aprv_start审批提醒/aprv_end审批通过/aprv_reject审批驳回/changeemail修改邮箱/resetpwd修改密码
content object 模板内容
{'name':'wangwu','height':'180'}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
企业信使短信发送
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
mobile string 手机号
content string 短信内容
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

邮箱验证码


发送验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
email string 邮箱
event string 事件名称:register注册/changeemail更改邮箱/resetpwd用邮箱重置密码/changepwd
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
检测验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
email string 邮箱
event string 事件名称
captcha string 验证码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-平台高级管理


显示平台列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
limit integer 每页数量,默认10
page integer 页码,默认1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增平台
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
name string 平台名称
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的平台
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
id string 平台guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注意:仅传需更新的字段
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
name string 平台名称
江苏省农科院
id string 平台guid
xxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定平台
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
id string 平台guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示应用列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示应用帮助手册
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新应用帮助手册
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
app_guid string 应用guid
xxxxx
content object 帮助手册内容,json格式,图片通过公共接口上传获取地址
[{'id':1,'title':'帮助1','answer':'如何如何','pics':['http://1','http://2']},{'id':2,'title':'帮助2','answer':'如何如何','pics':['http://1','http://2']}]
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增应用
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
platform_guid string 应用所属平台guid
86c5ed47106c9003
app_type string 应用类型,web(网站)或third_app(第三方应用)
third_app
title string 应用标题
鸿景物联溯源(发布版)
desc string 应用描述
鸿景物联溯源(发布版)
url string 网站域名,应用类型为web必填
http://www.xxx.com
third_id integer 第三方应用类型id,应用类型为third_app必填,1微信网站应用、2微信公众号、3微信小程序、4微信open开发平台APP
3
account string 第三方应用登录账户,应用类型为third_app必填
abc@126.com
appid string 第三方应用appid,应用类型为third_app必填
wxabcdefghijklmn
appsecret string 第三方应用appsecret,应用类型为third_app必填
e569b32833968a1231231231239041
gh_id string 第三方应用原始id,应用类型为third_app,且third_id为2或3必填
gh_5aa4f7bb6127
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增企业隐藏超管
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
平台超管可管理平台内应用、企业、用户,可接管企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
platform_guid string 平台guid
86c5ed47106c9003
user_id integer 用户id
1111
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
平台超管可清空所有用户token
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
platform_guid string 平台guid
86c5ed47106c9003
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
平台超管可清空指定用户token
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;),其中app_guid必须是中心超管应用
参数
名称 类型 必选 描述 示例
platform_guid string 平台guid
86c5ed47106c9003
user_id integer 用户id
1111
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-平台基础管理


显示平台面板数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
接管企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_guid string 要接管的企业guid
xxxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注意:仅传需更新的字段。自动同步企业信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
pack_type integer 套餐类型
1
pack_valid_time string 套餐到期时间,不传则默认永久有效
2022-10-1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-企业权限管理


显示中心全部权限节点
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示企业套餐权限信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示企业职能角色列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增企业职能角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
auth_name string 职能角色名称
生化部危险品实验人员
node_ids string 权限节点id,逗号分隔,需同时传选中子节点的所有父节点id
97,98,99,100,101,14,13
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新企业职能角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
auth_group_id integer 职能角色id
1
node_ids string 权限节点id,逗号分隔,需同时传选中子节点的所有父节点id
97,98,99,100,101,14,13
auth_name string 职能角色名称
生化部危险品实验人员
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除企业职能角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
auth_group_id integer 职能角色id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新企业员工职能角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
staff_guid string 员工guid
xxxxxx
group_ids string 职能角色id,从属多个以逗号分隔
1,2
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示企业岗位角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增企业岗位角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
career_title string 岗位名称
经理
level integer 岗位级别,不传则默认1
8
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新企业岗位角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
career_id integer 岗位角色id
1
career_title string 企业专属岗位名称
经理
level integer 岗位级别
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除企业岗位角色
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
career_id integer 岗位角色id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-企业基础管理


显示企业列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
limit integer 每页数量,默认10
page integer 页码,默认1
my_registered integer 是否只显示登录用户注册的企业(1是0否),默认0显示全部
search string 根据企业名模糊搜索
search_status integer 申请状态(0审核通过和待审核|1审核通过|2待审核|3审核拒绝|4全部)默认0
organization_attribute integer 企业属性/单位类型,支持英文逗号分隔多个属性,如14,15
levelcode integer 省市区级别,如1,2,3,默认0显示全部
only_sub integer 是否仅显示下级企业(1是0否),默认0显示全部
start_time string 注册时间,格式2020-01-01(查询开始)
end_time string 注册时间,格式2020-01-01(查询结束)
forward_organization_guid string 注册渠道guid,格式abcdefg
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
id string 企业guid
staff_guid string 员工guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询技术机构列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询企业简单信息列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
organization_attribute integer 企业属性/单位类型,支持英文逗号分隔多个属性,如14,15
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
批量导入企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
file_path string 文件路径(上传文件/api/common/upload接口返回的url),格式xlsx
/uploads/xxx.xlsx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
批量导入企业预览
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
file_path string 文件路径(上传文件/api/common/upload接口返回的url),格式xlsx
/uploads/xxx.xlsx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
批量导入模板下载
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
批量新增企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
企业新增单个用户和员工
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxx
staff_name string 员工姓名
王思聪
mobile string 员工手机号
18688888888
tel string 员工办公电话
025-8888888
address string 员工地址
南京xxxxx
area_id string 员工区域id,显示中国省市县列表/api/common/area_list获得,精确到区级,鼓楼区825
825
staff_no string 员工工号
5
industry_id string 员工行业id
1
group_ids string 员工职能角色id,从属多个以逗号分隔
1,2
signature string 员工数字签名
http://url
desc string 员工备注
新入职1个月
status integer 员工状态(0待审核 1在职 2离职 3停薪留职 4退休 5返聘)
1
birthday string 用户生日
2021-08-31
gender integer 用户性别(0未知 1男 2女)
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定企业的审核意见
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
id string 企业guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增成功自动同步企业信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
pid string 上级企业guid
xxxxxx
name string 企业名称
abc公司
username string 企业用户名,用于分配账号
abc
desc string 企业描述
legal_person_name string 企业法人
王思聪
address string 地址
南京xxxxx
license string 统一社会信用代码
91320102MA1Q2EQK0R
license_pic string 营业执照图片
https://oss.pic.com/1.jpg
business_term string 营业期限(格式:2017/01/01-2025/01/01)
2017/01/01-2025/01/01
is_long string 是否长期(0否 1是)
organization_code string 组织机构代码
MA1Q2EQK-0
area_code string 行政编码
110100000000
precinct string 管辖区编码集合,用于行政部门或其他部门管理的辖区,多个编码用|分隔
320000|320001
area_id string 区域id,显示中国省市县列表/api/common/area_list获得,精确到区级,鼓楼区825
825
zipcode string 邮政编码
210000
industry_id string 行业id
1
levelcode string 机构级别(省级1,市级2,区县级3),默认0
1
organization_attribute string 企业属性(1股份有限公司 2有限责任公司 3国有企业 4集体所有制 5私营企业 6有限合伙企业 7联营企业 8外商投资企业 9个人独资企业 10非盈利机构 11政府部门 12一般性工作机构 13社会团体 14GAP技术机构 15GAP工作机构)
14
contact object 联系人信息(集合)
[{'contact_person':'姓名(必填)','contact_person_pos':'职务','contact_person_id_card':'身份证号','contact_mobile':'手机号','contact_fax':'传真','contact_email':'电子邮件','contact_tel':'座机号码','contact_qq':'QQ号码'},{'contact_person':'小王','contact_person_pos':'总经理','contact_person_id_card':'21080819900101000X','contact_mobile':'18888888888','contact_fax':'025-66666666','contact_email':'example@qq.com','contact_tel':'025-88888888','contact_qq':'88888888'}]
channel object 注册渠道(集合),key为自定义渠道名,value为渠道标识,支持key:forward_organization_guid
{'forward_organization_guid':'abcdefg'}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
审核企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
id string 企业guid
xxxxxx
action string 审核操作(accept审核通过/reject审核拒绝)
accept
staff_guid string 员工guid
xxxxxx
comment string 审核意见
同意
signature string 数字签名
https://url
attachment string 附件
https://url
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注意:仅传需更新的字段。自动同步企业信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
id string 企业guid
xxxxxx
pid string 上级企业guid
xxxxxx
name string 企业名称
abc公司
desc string 企业描述
legal_person_name string 企业法人
王思聪
address string 地址
南京xxxxx
license string 统一社会信用代码
91320102MA1Q2EQK0R
license_pic string 营业执照图片
https://oss.pic.com/1.jpg
business_term string 营业期限(格式:2017/01/01-2025/01/01)
2017/01/01-2025/01/01
is_long string 是否长期(0否 1是)
organization_code string 组织机构代码
MA1Q2EQK-0
area_code string 行政编码
110100000000
precinct string 管辖区编码集合,用于行政部门或其他部门管理的辖区,多个编码用|分隔
320000|320001
area_id string 区域id,显示中国省市县列表/api/common/area_list获得,精确到区级,鼓楼区825
825
zipcode string 邮政编码
210000
industry_id string 行业id
1
levelcode string 机构级别(省级1,市级2,区县级3)
1
organization_attribute string 企业属性(1股份有限公司 2有限责任公司 3国有企业 4集体所有制 5私营企业 6有限合伙企业 7联营企业 8外商投资企业 9个人独资企业 10非盈利机构 11政府部门 12一般性工作机构 13社会团体 14GAP技术机构 15GAP工作机构)
14
resubmit integer 是否重新提交审核(1是,0否),默认0否
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
根据企业名称模糊查询企业信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
name string 企业名称
only_name boolean 仅返回企业名称,用于autocomplete,true或false,默认true时为模糊查询,false为精准匹配
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定企业的简单信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
53b5e5d4466712c7
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
id string 企业guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
自动同步企业信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
xxxxxx
contact_id integer 联系人id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
自动同步企业信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
id string 企业guid
xxxxxx
contact object 联系人信息(集合)
[{'id':'不填则新增数据,填则修改此id数据','contact_person':'姓名(必填)','contact_person_pos':'职务','contact_person_id_card':'身份证号','contact_mobile':'手机号','contact_fax':'传真','contact_email':'电子邮件','contact_tel':'座机号码','contact_qq':'QQ号码'},{'id':'','contact_person':'小王','contact_person_pos':'总经理','contact_person_id_card':'21080819900101000X','contact_mobile':'18888888888','contact_fax':'025-66666666','contact_email':'example@qq.com','contact_tel':'025-88888888','contact_qq':'88888888'}]
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
企业发送邮件
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)
参数
名称 类型 必选 描述 示例
mail_to string 收件人邮箱
abc@mai.qq.com
name string 姓名
张三
contact string 联系方式
18888888888
subject string 邮件主题
易联通供应链平台
body string 邮件正文
我想咨询
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-企业部门管理


显示部门列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
limit integer 每页数量,默认10
page integer 页码,默认1
corporation_guid string 企业guid
is_tree boolean 是否显示树状结构,默认false,若为true则不分页
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增成功自动同步企业所有部门信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
name string 部门名称
corporation_guid string 企业guid
pid string 上级部门guid
is_default integer 是否默认部门(1是0否),默认0否
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的部门
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 部门guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注意:仅传需更新的字段。自动同步企业所有部门信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
name string 部门名称
信息部
pid string 上级部门guid
xxxxx
id string 部门guid
xxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定部门
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 部门guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
实体传递部门树结构对象。自动同步企业所有部门信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
department_tree object 部门树结构对象
[{'id':3, 'pid':2, 'name':'总经办', 'childlist': [{'id':4, 'pid':3, 'name':'考勤组', 'childlist':[]},{}]},{}]
corporation_guid string 企业guid
xxxxxxxxxxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-企业员工管理


显示员工列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
limit integer 每页数量,默认10
page integer 页码,默认1
corporation_guid string 企业guid
search string 根据员工名模糊搜索
department_guid string 部门guid,多个以英文逗号隔开
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示员工列表树状结构
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
department_guid string 部门guid
career_id string 岗位角色id
staff_name string 员工姓名,支持模糊查询
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示企业所有员工姓名
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid
staff_name string 员工姓名,支持模糊查询
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增成功自动同步企业所有员工信息。接口分用户端调用和企业管理端调用:1、用户端调用,姓名、用户guid、企业guid必传(通过主动搜索或扫码获取企业guid),若企业未发出过邀请,则用户状态为待审核,若企业发出过邀请,则自动绑定;2、企业管理端调用,姓名、企业guid必传。若用户存在,则自动绑定,推送通知。若用户不存在,则用户注册登录后自动绑定。若用户先申请加入企业,则提示待审核中已有用户,可修改用户状态。
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
staff_name string 员工姓名
user_guid string 用户guid,用户主动申请加入企业(用户端接口)
mobile string 企业填员工手机号(企业管理端接口)用户若已存在,则收到提醒手动绑定,或登录后自动绑定。用户若不存在,注册登录后,自动绑定,并收到提醒
corporation_guid string 企业guid,企业管理端可直接取值,用户端可扫二维码获得
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的员工
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
注意:仅传需更新的字段。自动同步企业所有员工信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
xxxxx
staff_name string 员工姓名
王思聪
mobile string 员工手机号
18688888888
tel string 员工办公电话
025-8888888
address string 员工地址
南京xxxxx
area_id string 员工区域id,显示中国省市县列表/api/common/area_list获得,精确到区级,鼓楼区825
825
staff_no string 员工工号
5
industry_id string 员工行业id
1
group_ids string 员工职能角色id,从属多个以逗号分隔
1,2
signature string 员工数字签名
http://url
desc string 员工备注
新入职1个月
status integer 员工状态(0待审核 1在职 2离职 3停薪留职 4退休 5返聘)
1
birthday string 用户生日
2021-08-31
gender integer 用户性别(0未知 1男 2女)
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
用户解绑企业员工
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
xxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
用户未设置过默认登录的企业,将登录平台内用户所属的第一个企业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_guid string 设置后的默认企业guid
xxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新默认部门将会自动更新对应的默认岗位
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
xxxxx
department_guid string 员工默认部门guid
xxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
数字签名需先调用common/upload接口上传图片
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
xxxxx
signature string 数字签名地址,通过公共接口upload获取
https://url
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
增加员工指定部门的岗位
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
xxxxx
department_guid string 部门guid
xxxxx
career_id integer 岗位id,通过公共接口获取id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
1、员工所在原部门是否保留?2、转部门是切换默认所属部门吗?3、如果之前没有该部门岗位是提示不属于该部门还是自动增加该部门岗位?4、批量调转,需要前端对每个员工都预设好岗位?5、已登录用户的权限如何控制?1、此功能针对到具体的某一“部门x岗位”配置,1换1,原部门不保留;2、原部门是默认部门切换过去的新部门依然是默认部门,原部门不是默认部门反之;3、自动增加‘岗位’;4、嗯,会留这个字段的,但是同一批次的被操作人员,设置的参数会相同,例:A部门A岗位和B部门B岗位的2人,同时调到C部门C岗位。5、必然是强退
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
staff_department_careers object 员工部门岗位对象
{}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除员工指定部门的岗位
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
xxxxx
department_guid string 部门guid
xxxxx
career_id integer 岗位id,通过公共接口获取id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定员工
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 员工guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取登录用户的公司员工
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(限定查询的范围)
参数
名称 类型 必选 描述 示例
department_restrict boolean 是否限制本部门,默认false为全公司
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-通信与同步


微服务调用说明
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
仅同步微服务正式接口,非测试域名
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
server_name string 需同步的微服务标识
zmsaas-gap
version string 版本号
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-审批链


显示审批列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;)app_guid当前应用guid,corporation_guid当前登录的企业guid(限定审批查询的范围)
参数
名称 类型 必选 描述 示例
staff_id string 相关员工guid,仅显示和此员工相关的审批
xxxxx
relate_chain_guid string 企业审批模板筛选
xxxxx
relate_order_info string 关联微服务信息筛选,前端构造一个或多个查询条件,以;分隔
Type=申购;Unit=瓶;Spec=500ml/瓶;
search_type integer 相关类型(1所有相关类型 2审批发起人 3当前审批人 4所有审批人 5所有抄送人 6所有审批人和所有抄送人),不传则默认显示1所有相关类型
2
status integer 审批状态(0待审批 1审批完成 2审批中 3审批多级驳回待修改 4审批拒绝并终止 5所有),不传则默认显示0待审批
5
time_type integer 查询时间类型(1审批创建时间 2审批结束时间),不传默认1
1
start_time string 查询开始时间,可以是date或datetime
20210101
end_time string 查询结束时间,可以是date或datetime
20210102 23:59:59
limit integer 每页数量,默认10
page integer 页码,默认1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的审批
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新建审批
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
relate_server_id integer 关联的微服务id,wms为9
9
relate_order_id string 关联微服务交易单id
1a2b401cefa2446a
relate_order_info object 关联微服务交易单实体信息,json格式,作为镜像保存
{'Id': 1,
    'GUID': 'sample string 2',
    'SN': 'sample string 3',
    'Status': 4,
    'Pic': 'sample string 5',
    'Remark': 'sample string 6',
    'Type': 'sample string 7',
    'CreateTime': '2020-04-14T11:32:34.244124+08:00',
    'StaffGUID': 'sample string 9',
    'Detail': [
    {
    'ItemName': 'sample string 1',
    'Spec': 'sample string 2',
    'ItemId': 3,
    'Amount': 4.1,
    'InAmount': 5.1,
    'Unit': 'sample string 6'
    },
    {
    'ItemName': 'sample string 1',
    'Spec': 'sample string 2',
    'ItemId': 3,
    'Amount': 4.1,
    'InAmount': 5.1,
    'Unit': 'sample string 6'
    }
    ]}
relate_chain_guid string 关联微服务chain_guid(中心approval_template_corporation企业审批模板guid)
dc65e77a4765f258
from_staff_id string 发起审批的员工guid
xxxxx
comment string 发起人附言,是否必填取决于企业审批模板发起人配置
帮忙通过一下,很急
signature string 发起人数字签名,是否必填取决于企业审批模板发起人配置
https://url
attachment string 发起人附件,是否必填取决于企业审批模板发起人配置
https://url
next_node_approval_staff_guid string 指定下一节点审批的员工guid,仅当下一节点mode为appoint时必传
xxxxx
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
编辑审批内容
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
xxxxxx
relate_order_info object 关联微服务交易单实体信息,json格式,作为镜像保存
{'Id': 1,
    'GUID': 'sample string 2',
    'SN': 'sample string 3',
    'Status': 4,
    'Pic': 'sample string 5',
    'Remark': 'sample string 6',
    'Type': 'sample string 7',
    'CreateTime': '2020-04-14T11:32:34.244124+08:00',
    'StaffGUID': 'sample string 9',
    'Detail': [
    {
    'ItemName': 'sample string 1',
    'Spec': 'sample string 2',
    'ItemId': 3,
    'Amount': 4.1,
    'InAmount': 5.1,
    'Unit': 'sample string 6'
    },
    {
    'ItemName': 'sample string 1',
    'Spec': 'sample string 2',
    'ItemId': 3,
    'Amount': 4.1,
    'InAmount': 5.1,
    'Unit': 'sample string 6'
    }
    ]}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除审批
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
反馈审批结果 TODO
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
编辑审批意见
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
xxxx
staff_id string 员工guid
9a95e5e8a8c7b779
action string 审批操作(accept当前节点审批通过/reject审批多级驳回至修改订单/retrial审批单级驳回到上一节点/terminate审批拒绝并终止订单)
accept
comment string 审批意见
同意
signature string 数字签名
https://url
attachment string 附件
https://url
next_node_approval_staff_guid string 指定下一节点审批的员工guid,仅当下一节点mode为appoint时必传
xxxxx
cur_node_cc_staff_guids string 指定当前节点审批的员工guid集合,英文逗号分隔,仅当本节点mode为appoint时选填
aaaaa,bbbbb,ccccc
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
关联其他审批
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取审批结果
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
关联自定义工作表单 TODO
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
中心通知工作流开始
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
中心通知工作流结束
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
中心通知工作流拒绝至订单修改状态
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
中心通知工作流终止订单
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示审批链模板
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批链模板guid,可选
xxx
limit integer 每页数量,默认10
page integer 页码,默认1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新建审批链模板
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
name string 模板名称
通用模板
desc string 模板描述
适用于任意审批场景
icon string 模板图标地址(公共接口上传文件后获取)
/uploads/20200304/2c38917feeb40aeabf07b88afce00c88.png
config object 模板配置
{'base':{'from_who':'all'},'form':{'components':'stock_out_apply|time|attachment|remark'},'process':{'from_who':'all','approval_by':'all|chain','cc':'all'},'advance':{'unique':'no','notice':'','comment_required':'yes','signature_required':'yes'}}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改审批链模板
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批链模板guid
xxxxx
name string 模板名称
通用模板
desc string 模板描述
适用于任意审批场景
icon string 模板图标地址(公共接口上传文件后获取)
/uploads/20200304/2c38917feeb40aeabf07b88afce00c88.png
config object 模板配置
{'base':{'from_who':'all'},'form':{'components':'stock_in_apply|time|attachment|remark'},'process':{'from_who':'all','approval_by':'all|chain','cc':'all'},'advance':{'unique':'no','notice':'','comment_required':'yes','signature_required':'yes'}}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除审批链模板
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 审批链模板guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示企业审批链设计
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 企业审批链设计guid,可选
xxx
template_guid string 审批链模板guid,可选
xxx
corporation_guid string 企业guid,可选
xxx
search string 根据审批链设计名称模糊搜索,可选
xxx
staff_guid string 创建员工的guid,可选,支持多个,英文逗号隔开
xxx,yyy
limit integer 每页数量,默认10
page integer 页码,默认1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新建企业审批链设计
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
template_id string 审批链模板guid,从中心template接口获得
9e95e776b2d3a8dd
name string 模板名称,不传则默认为中心模板名称
A企业申购单
desc string 模板描述
A企业申购使用
corporation_id string 企业guid
53b5e5d4466712c7
department_ids string 适用部门guid,英文逗号分隔,为空则适用于全企业
aaaa,bbbbb,cccc
staff_id string 创建人员工guid
xxxxx
options object 关联属性
{'ProductCategoryIds':'35|36'}
config object 模板权限节点配置
{
    'from_who': 'all',
    'comment': 'no',
    'attachment': 'yes',
    'signature': 'no',
    'expire_at': '+3 days',
    'approval_nodes': [
    {
    'approval':{
    'approval_by':[{'staff_guid': 'd4f5e5e8605c1f10',
    'department_guid': 'bbb5e5e6075dda6c'},
    {'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'}],
    'mode': 'or',
    'appoint_cc_config': 0,
    'expire_at': '+1 week 3 days 7 hours 5 seconds',
    'comment': 'yes',
    'attachment': 'yes',
    'signature': 'yes'},
    'cc': [{
    'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'
    }]
    },
    {
    'approval':{
    'approval_by':[{'staff_guid': '9225e5e8ab069800',
    'department_guid': 'bb65e5e589379e3a'},
    {'staff_guid': '85e5e5e8ab5ba6ac',
    'department_guid': 'bb65e5e589379e3a'}],
    'mode': 'and',
    'appoint_cc_config': 0,
    'expire_at': 'next Monday',
    'comment': 'yes',
    'attachment': 'yes',
    'signature': 'yes'},
    'cc': [{
    'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'
    }]
    },
    {
    'approval':{
    'approval_by':[{'staff_guid': '6d15e5e8ac43e256',
    'department_guid': 'bb65e5e589379e3a'},
    {'staff_guid': '3385e5e8ac91f616',
    'department_guid': '47a5e61e9fa285f5'}],
    'mode': 'appoint',
    'appoint_cc_config': 'all',
    'expire_at': '2020-05-26 23:55:50',
    'comment': 'yes',
    'attachment': 'yes',
    'signature': 'yes'},
    'cc': [{
    'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'
    },
    {
    'staff_guid': 'd4f5e5e8605c1f10',
    'department_guid': 'bbb5e5e6075dda6c'
    }
    ]
    }
    ],
    'cc': [{
    'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'
    },
    {
    'staff_guid': 'd4f5e5e8605c1f10',
    'department_guid': 'bbb5e5e6075dda6c'
    }
    ]
    }
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改企业审批链设计
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 企业审批链设计guid
xxxxx
name string 模板名称
A企业申购单
desc string 模板描述
A企业申购使用
department_ids string 适用部门guid,英文逗号分隔,为空则适用于全企业
aaaa,bbbbb,cccc
options object 关联属性
{'ProductCategoryIds':'35|36'}
config object 模板权限节点配置,节点填角色链guid
{
    'from_who': 'all',
    'comment': 'no',
    'attachment': 'yes',
    'signature': 'no',
    'expire_at': '+7 days',
    'approval_nodes': [
    {
    'approval':{
    'approval_by':[{'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'},
    {'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'}],
    'mode': 0,
    'appoint_cc_config': 0,
    'expire_at': 0,
    'comment': 'yes',
    'attachment': 'yes',
    'signature': 'yes'},
    'cc': [{
    'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'
    }]
    },
    {
    'approval':{
    'approval_by':[{'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'},
    {'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'}],
    'mode': 'and',
    'appoint_cc_config': 0,
    'expire_at': '+5 days',
    'comment': 'yes',
    'attachment': 'yes',
    'signature': 'yes'},
    'cc': [{
    'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'
    }]
    },
    {
    'approval':{
    'approval_by':[{'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'},
    {'staff_guid': 'c3f5e5e8aa9c8b27',
    'department_guid': 'bb65e5e589379e3a'}],
    'mode': 'appoint',
    'appoint_cc_config': 'appoint',
    'expire_at': '15 June 2020',
    'comment': 'yes',
    'attachment': 'yes',
    'signature': 'yes'},
    'cc': [{
    'staff_guid': '8fe5e5e8aa0dfc0b',
    'department_guid': 'bb65e5e589379e3a'
    },
    {
    'staff_guid': '6d15e5e8ac43e256',
    'department_guid': 'bb65e5e589379e3a'
    }
    ]
    }
    ],
    'cc': [{
    'staff_guid': '5e25e5e8ace89eb2',
    'department_guid': 'bb65e5e589379e3a'
    },
    {
    'staff_guid': '2355e5e8ad45a4f0',
    'department_guid': 'bb65e5e589379e3a'
    }
    ]
    }
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除企业审批链设计
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string 企业审批链设计guid
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取角色链,不存在则新建
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_id string 企业guid
53b5e5d4466712c7
department_id string 部门guid
bbb5e5e6075dda6c
career_id string 岗位id
1
staff_id string 员工guid
9a95e5e8a8c7b779
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-仓库管理


接口调用说明
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-GAP


接口调用说明
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取并同步GAP微服务接口
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询缓存中的用户
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询微服务内部状态码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
同步平台下所有企业,部门,员工信息,通过app_guid关联获取平台
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
同步指定企业信息,对guid或name查重
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id integer 企业id
9
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
同步指定企业下所有部门信息
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_id integer 企业id
9
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
同步指定企业下所有员工信息
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_id integer 企业id
9
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
创建申请书
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization
参数
名称 类型 必选 描述 示例
StaffGuid string 员工guid
body object 请求参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
上传文件,返回文件hash和远程文件名 todo
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
StaffGuid string 员工guid
formFile file 文件
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-电商管理


显示当前报表电商商品与系统产品列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
file_path string Xlsx|Xls|Csv格式文件路径,通过公共接口upload获得
/uploads/20200814/de18248432cc73b98ce3f435aed98afa.xlsx
source_id integer 渠道来源id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示所有电商商品绑定系统产品列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
type_id integer 渠道id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
同步溯源2.0企业的产品列表到dataworks的ec_sys_goods中
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
type_id integer 渠道id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
电商商品绑定系统产品
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_id integer 渠道来源id,通过显示渠道get_channels获得,如source_id为1:天猫订单报表
1
file_path string Xlsx|Xls|Csv格式文件路径,通过公共接口upload获得。此项为空时即编辑所有的绑定项。
/uploads/20200814/de18248432cc73b98ce3f435aed98afa.xlsx
map_list object 绑定关系集合,格式为电商商品id:系统产品id
[{'goods_id':1,'sys_goods_id':228},{'goods_id':2,'sys_goods_id':229}]
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
手动录入数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_id integer 渠道来源id
3
submit_data object 表单数据集合,表单字段stats_fields通过显示渠道数据报表模板get_channel_template获得
{'order_no':'E20200824184935087000053','order_create_time':'2020-8-24 18:49:35','order_payment_paid':'107.00','receiver_province':'江苏省','receiver_city':'无锡市','receiver_district':'江阴市','detailed_address':'华西村1号'}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示渠道数据明细
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_id integer 渠道来源id,通过显示渠道get_channels获得,如source_id为1:天猫订单报表
1
limit integer 每页数量,默认10
page integer 页码,默认1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示动态路由
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示渠道
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示渠道数据报表模板
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_id integer 渠道来源id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增渠道
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
name string 渠道名称
京东
desc string 渠道描述
京东商城
official_site string 官方网站
http://www.xxx.com
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新渠道
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_type_id integer 渠道id
3
name string 渠道名称
京东
desc string 渠道描述
京东商城
official_site string 官方网站
http://www.yyy.com
status string 状态,on|off
off
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除渠道
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_type_id integer 渠道id
3
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
手动导入ODS数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
source_id integer 数据来源id
3
id_start integer 数据id开始
1
id_end integer 数据id结束
10
limit integer 单任务处理数据量限制,默认1000
1000
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
在ods_goods和ods_orders数据导入完成后,执行此方法生成大屏展示所需的异构基础数据,后期数据量过多应分化出独立分屏异构数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id_start integer 数据id开始,默认1
1
id_end integer 数据id结束,默认总数据长度
10
limit integer 单任务处理数据量限制,默认1000
1000
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
手动生成01汇总数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
根据查询标识name获取某个板块数据,stat_01(stat_0001+stat_0002),stat_02(stat_0003+stat_0004),stat_03(stat_0005+stat_0006),stat_04(stat_0007+stat_0008),stat_05(stat_0009+stat_0010),stat_06(stat_0011+stat_0012)
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
name string 数据查询标识,共6个(stat_01,stat_02,stat_03,stat_04,stat_05,stat_06)
stat_01
start_date string 查询开始日期,stat_01此参数不生效
2020-02-01
end_date string 查询结束日期,stat_01此参数不生效
2020-08-31
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
华西大屏获取外部水产物联网信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-医疗设备


查询设备列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
corporation_guid string 所属机构guid
abcdef
department_guid string 所属部门guid
abcdef
staff_guid string 所属员工guid
abcdef
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
jnq_mode integer 设备工作模式(默认0不限制 1分时计尿模式 2膀胱训练 3尿潴留 4膀胱冲洗)
device_name string 指定要查询的设备的名称
JNQ_2
jnq_func integer 服务模式:预警类型(默认0不限制 1多尿预警(每小时) 2多尿预警(N小时) 3少尿预警(每小时) 4少尿预警(N小时) 5断网 6尿袋脱落 7膀胱冲洗超时)
1
limit integer 每页数量,默认10
50
page integer 页码,默认1
1
order string 排序字段,以竖线分割,支持参数:id、bed_no床号,默认按id倒序:id-desc
bed_no-asc|id-asc
patient_name string 当前绑定患者姓名
张三
bed_no string 当前患者床号
101
status integer 设备禁启用状态(0禁用,1启用)
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增或更新患者设备绑定关系
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
patient_id integer 患者ID
1
iot_id string 绑定的设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
is_binding integer 是否绑定,默认1-绑定,0-解绑
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取设备详情数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
iot_id string 设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改指定设备的信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
iot_id string 设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
custom_name string 自定义设备名称
计尿器1
corporation_guid string 所属机构guid
abcdef
department_guid string 所属部门guid
abcdef
staff_guid string 所属员工guid
abcdef
status integer 设备禁启用状态(0禁用,1启用)
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取设备历史数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
iot_id string 设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
设置设备预警阈值参数
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
iot_ids string 设备iot_id,多个以英文逗号隔开
7C8OvDCM7mOEe15OXFevi8mx00,7C8OvDCM7mOEe15OXFevi8mx01
hour_upper_limits integer 每小时多尿预警值,默认100
100
hours_upper_limits integer 累计多尿预警值,默认2500
2500
hour_lower_limits integer 每小时少尿预警值,默认17
17
hours_lower_limits integer 累计少尿预警值,默认400
400
interval integer 累计预警统计时间(小时),默认24
20
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示患者列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
corporation_guid string 患者绑定设备的所属机构guid
abcdef
department_guid string 患者绑定设备的所属部门guid
abcdef
staff_guid string 患者绑定设备的所属员工guid
abcdef
limit integer 每页数量,默认10
50
page integer 页码,默认1
1
order string 排序字段,以竖线分割,支持参数:id、patient_name姓名、bed_no床号、hospitalization_time入院时间、discharge_time出院时间,默认按id倒序:id-desc
patient_name-asc|hospitalization_time-desc|id-asc
patient_name string 姓名
张三
sex integer 性别,1男、2女
1
age_start integer 年龄查询开始
30
age_end integer 年龄查询结束
50
bed_no string 床号
101
mrn string 病历号
700756
start_time string 起始住院时间,格式2023-01-01(查询开始)
2023-01-01
end_time string 截止住院时间,格式2023-12-31(查询结束)
2023-12-31
in_hospital integer 是否仅看当前住院,0否、1是,默认0
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
新增患者
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
patient_name string 姓名
张三
mobile string 电话号码
18888888888
birthday string 生日
1988-08-08
address string 地址信息
北京市朝阳区1号
headimgurl string 头像
https://url
bed_no string 床号
101
sex integer 性别,1男、2女
2
mrn string 病历号
700756
height string 身高(单位:cm)
176.52
weight string 体重(单位:kg)
60.53
major_disease string 主要疾病
肠炎
remark string 备注
一日三次
custom_name string 备注名
小王
hospitalization_time string 入院时间
2023-01-01 12:03:12
discharge_time string 出院时间
2023-12-31 12:03:12
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
更新患者信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
patient_id integer 要更新的记录ID
1
patient_name string 姓名
张三
mobile string 电话号码
18888888888
birthday string 生日
1988-08-08
address string 地址信息
北京市朝阳区1号
headimgurl string 头像
https://url
bed_no string 床号
101
sex integer 性别,1男、2女
2
mrn string 病历号
700756
height string 身高(单位:cm)
176.52
weight string 体重(单位:kg)
60.53
major_disease string 主要疾病
肠炎
remark string 备注
一日三次
custom_name string 备注名
小王
hospitalization_time string 入院时间
2023-01-01 12:03:12
discharge_time string 出院时间
2023-12-31 12:03:12
iot_id string 病患绑定的设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的患者信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
patient_id integer 要查看的记录ID
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定患者
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
patient_id integer 要删除的记录ID
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示交接班规则列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
limit integer 每页数量,默认10
50
page integer 页码,默认1
1
order string 排序字段,以竖线分割,支持参数:id、shift_time交接班时刻、shift_cycle交接班周期,默认按id倒序:id-desc
shift_time-asc|shift_cycle-asc|id-asc
corporation_guid string 机构guid
53b5e5d4466712c7
department_guid string 部门guid
abcdef
staff_guid string 员工guid
abcdef
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
相同的机构guid、部门guid只会存在唯一交接班规则,当重复请求时,将更新原数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
corporation_guid string 机构guid
53b5e5d4466712c7
department_guid string 部门guid
abcdef
shift_time string 交接班时刻
14:30:28
shift_cycle string 交接班周期(小时)
24
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定交接班规则
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
id integer 要删除的记录ID
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
处理复位预警日志信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
id string 预警日志id
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询预警日志列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
corporation_guid string 所属机构guid
abcdef
department_guid string 所属部门guid
abcdef
staff_guid string 所属员工guid
abcdef
iot_id string 设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
device_name string 指定要查询的设备的名称
JNQ_2
patient_name string 患者姓名
张三
type integer 预警类型(0全部 1多尿预警(每小时) 2多尿预警(N小时) 3少尿预警(每小时) 4少尿预警(N小时))
limit integer 每页数量,默认10
50
page integer 页码,默认1
1
order string 排序字段,以竖线分割,支持参数:id,默认按id倒序:id-desc
id-asc
occur_time string 发生时间
2023-01-01
handle_time string 处理时间
2023-01-01
days integer 查看近N天数据,默认0不限制
7
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询操作日志列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
corporation_guid string 所属机构guid
abcdef
department_guid string 所属部门guid
abcdef
iot_id string 设备iot_id
7C8OvDCM7mOEe15OXFevi8mx00
staff_guid string 所属员工guid
abcdef
limit integer 每页数量,默认10
50
page integer 页码,默认1
1
order string 排序字段,以竖线分割,支持参数:id,默认按id倒序:id-desc
id-asc
type string 操作类型
update_device
occur_time string 发生时间
2023-01-01
handle_time string 处理时间
2023-01-01
days integer 查看近N天数据,默认0不限制
7
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查看所有产品列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
page integer 页码,默认1
1
limit integer 每页数量,默认10
10
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询指定产品的详细信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string product_key是物联网平台为新建产品颁发的全局唯一标识符
i8mx6xKpH6t
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
修改指定产品的信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string product_key是物联网平台为新建产品颁发的全局唯一标识符
i8mx6xKpH6t
product_name string 修改后的产品名称。 产品名称长度为4~30个字符,可以包含中文、英文字母、数字和下划线(_)。一个中文汉字算2个字符。
计尿器
description string 描述产品信息。长度不超过100个字符。一个中文算一个字符。
第二代产品。
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定产品
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string product_key是物联网平台为新建产品颁发的全局唯一标识符
i8mx6xKpH6t
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询指定设备的基本信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
device_name string 指定要查询的设备的名称
JNQ_2
iot_id string 如果传入该参数,则无需传入product_key和device_name。iot_id作为设备唯一标识符,和product_key与device_name组合是一一对应的关系。如果您同时传入iot_id和product_key与device_name组合,则以iot_id为准。
Q7uOhVRdZRRlDnTLv****00100
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询指定设备的详细信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
device_name string 指定要查询的设备的名称
JNQ_2
iot_id string 如果传入该参数,则无需传入product_key和device_name。iot_id作为设备唯一标识符,和product_key与device_name组合是一一对应的关系。如果您同时传入iot_id和product_key与device_name组合,则以iot_id为准。
Q7uOhVRdZRRlDnTLv****00100
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询指定产品下多个设备的详细信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
device_names string 指定要查询的设备的名称,多个用英文逗号分隔
JNQ_1,JNQ_2,JNQ_3
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询指定产品下的所有设备列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
page integer 页码,默认1
1
limit integer 每页数量,默认10
10
next_token string 下一页标识,首次查询无需传入。后续查询需使用的NextToken,要从上一次查询的返回结果中获取
TGlzdFJlc291cm***
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查看指定设备的运行状态
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
device_name string 指定要查询的设备的名称
JNQ_2
iot_id string 如果传入该参数,则无需传入product_key和device_name。iot_id作为设备唯一标识符,和product_key与device_name组合是一一对应的关系。如果您同时传入iot_id和product_key与device_name组合,则以iot_id为准。
Q7uOhVRdZRRlDnTLv****00100
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
根据设备状态查询设备列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
product_key string 要查询的设备所隶属的产品Key
i8mx6xKpH6t
status integer 0:未激活 1:在线 3:离线 8:已禁用
1
page integer 页码,默认1
1
limit integer 每页数量,默认10
10
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查看设备日志
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
limit integer 日志条数,默认100
100
page integer 页码,默认1
1
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
同意或拒绝授权
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
is_apply string 是否同意授权(0否 1是)
product_key string iot产品名称
i8mx6xKpH6t
device_name string iot设备名称
JNQ_2
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
type:1多尿预警(每小时)、2多尿预警(N小时)、3少尿预警(每小时)、4少尿预警(N小时)、5尿袋已满、8清空尿量日志信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
type integer 服务类型,详见接口说明
1
product_key string iot产品名称
i8mx6xKpH6t
device_name string iot设备名称
JNQ_2
data_value string 32位数据值,保留字段,暂时填0
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-物联网


获取AccessToken
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=d5a63f733f24b54f; corporation_guid=90d6410303beb703;)
参数
名称 类型 必选 描述 示例
platform_name string 开放平台标识(天翼云:vcp)
vcp
refreshToken string 刷新token时必传,非刷新token时参数不传
abcdef
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微服务-溯源管理


接口调用说明
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
手动登录Trace服务
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取当前用户所在企业的产品列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

微信相关接口


首页
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
EQS服务号微信jssdk测试
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
url string 当前网址
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

公共


显示当前应用的具体信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示当前应用的配置信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
加载初始化
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
version string 版本号
lng string 经度
lat string 纬度
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
上传文件
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
file File 文件流
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
阿里云OSS-OpenApi
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
file File 文件流
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
上传base64图片
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
base64_img string base64格式图片
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
生成图形验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
校验图形验证码
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
text string 文字
key string 验证key
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
默认仅返回前40条数据
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
file_path string 文件路径,通过公共接口upload获得,支持Xlsx|Xls|Csv格式
encoding string Csv编码格式,支持UTF-8|GBK,默认GBK
limit integer 数量,默认40
page integer 页码,默认0
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示行业
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id integer 行业id
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示行业列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
pid integer 上级行业id,默认0
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示中国省市县
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id integer 地区id
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示中国省市县列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
pid integer 上级地区id,默认0
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示中国省市县(area_code)
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
area_code string 地区area_code
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示中国省市县列表(area_code)
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
parent_area_code string 上级地区area_code,默认0
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示中国省市县信息(city_list)
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
level integer 级别(省级1,市级2,区县级3),默认0不限定
1
fields string 需查询的字段,英文逗号隔开(如shortname简称,name名称,province省,city市,district区县,mergename全称,level层级,pinyin拼音,area_code行政区划,code长途区号,zip邮编,first首字母,lng经度,lat纬度)
14
name_list object 地区名称(集合)
['厦门','南京']
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示当前城市天气
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
is_7days integer 是否显示七天数据,1是,0否,默认0
city string 城市简称,优先级高于IP地址
ip string IP地址
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示岗位型角色列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
corporation_guid string 企业guid,为空则获取全部系统岗位
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
快递100支持快递公司编码 https://api.kuaidi100.com/document/5f0ff6e82977d50a94e10237.html
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
com string 查询的快递公司的编码,一律用小写字母
shunfeng
num string 查询的快递单号,单号的最大长度是32个字符
xxxxxxxxxxxx
from string 出发地信息
广东省深圳市南山区金蝶软件园
to string 目的地信息
北京朝阳区国际金融大厦
phone string 收、寄件人的电话号码(手机和固定电话均可,只能填写一个,顺丰单号必填,其他快递公司选填。如座机号码有分机号,分机号无需上传。)
18888888888
order string 返回结果排序:desc降序(默认),asc升序
desc
orderTime string 订单下单时间,格式为(yyyy-MM-dd HH:mm:ss)
2020-12-16 12:59:59
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
生成软件注册码
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
type integer 注册码类型(1试用版 2正式版)
1
count integer 要生成几个注册码,默认1
1
can_num integer 每个注册码可注册设备数量,默认1
1
period string 注册码有效期,带单位,注意单位的单复数区别(例:1 hour、15 days、2 months、99 years)
15 days
remark string 备注
XXX项目使用的注册码
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
激活软件注册码
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
code string 注册码
ABCD-EFGH-IJKL-MNOP
device_identity string 客户端设备标识,如mac地址、uuid等
9C-B6-D0-69-F4-94
identity_type integer 设备标识类型,1 mac地址、2 uuid,不填默认为1 mac地址
2
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询当前应用app_guid的软件注册码列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
查询某台设备的激活记录和有效期截止时间
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
device_identity string 客户端设备标识,不传则返回本应用app_guid内所有激活记录
9C-B6-D0-69-F4-94
identity_type integer 设备标识类型,1 mac地址、2 uuid,不传则返回全部
2
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除设备在该应用的激活记录,并恢复注册码对应的可用额度
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
device_identity string 客户端设备标识
9C-B6-D0-69-F4-94
identity_type integer 设备标识类型,1 mac地址、2 uuid,不传则搜索全部
2
code string 注册码,不传则批量撤回
ABCD-EFGH-IJKL-MNOP
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
获取指定网页的内容
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
url string 网址
https://www.baidu.com
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

测试专用


首页
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
仅测试使用,将同时修改username,nickname,mobile
Headers
名称 类型 必选 描述
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
old_account string 原账户号(包括username,nickname,mobile)
new_account string 新账户号(包括username,nickname,mobile)
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

Restful测试


显示资源列表
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
保存新建的资源
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
username string 用户名
nickname string 用户昵称
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
显示指定的资源
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id int
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
保存更新的资源
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id int 资源id
username string 用户名
nickname string 用户昵称
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
删除指定资源
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id int 资源id
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数

权限测试


测试描述信息
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
id string id
123456
name string name
abc
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
{'code':'1','msg':'返回成功'}
测试描述信息abc
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
account string 账号
abc
password string 密码
123456
cache object cache
{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data object 扩展数据返回
{'code':'1','msg':'返回成功'}
需要登录的接口
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
account string 账号
abc
password string 密码
123456
cache object cache
{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数
需要登录且需要验证有相应组的权限
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
正文
名称 类型 必选 描述 示例
cache object cache
{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}
Headers
参数 / 正文
{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}
响应输出

                                                            

                                                        
返回参数
需要登录的接口
Headers
名称 类型 必选 描述
token string 请求的Token
Authorization string 请求的Authorization(例:app_guid=xxxxxx;)
参数
名称 类型 必选 描述 示例
account string 账号
abc
password string 密码
123456
cache object cache
{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}
正文
Headers
参数 / 正文
响应输出

                                                            

                                                        
返回参数