iMSE

会员

GET 会员中心 /api/user/index

会员中心

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 会员登录 /api/user/login

会员登录

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
account	string	是	账号
password	string	是	密码

正文

无

Headers

Authorization

参数 / 正文

account

password

响应输出

返回参数

无

无

POST 手机验证码登录 /api/user/mobilelogin

手机验证码登录

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

Headers

Authorization

参数 / 正文

mobile

captcha

响应输出

返回参数

无

无

POST 注册会员 /api/user/register

注册会员

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

Authorization

参数 / 正文

username

password

mobile

code

响应输出

返回参数

无

无

POST 注销登录 /api/user/logout

注销登录

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 修改会员个人信息 /api/user/profile

修改会员个人信息

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

token

Authorization

参数 / 正文

avatar

username

nickname

bio

gender

birthday

realname

license_type

license_no

bank_name

bank_account

响应输出

返回参数

无

无

POST 修改邮箱 /api/user/changeemail

修改邮箱

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
email	string	是	邮箱
captcha	string	是	验证码

正文

无

Headers

token

Authorization

参数 / 正文

captcha

响应输出

返回参数

无

无

POST 修改手机号 /api/user/changemobile

修改手机号

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

Headers

token

Authorization

参数 / 正文

mobile

captcha

响应输出

返回参数

无

无

POST 重置密码 /api/user/resetpwd

重置密码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
mobile	string	否	手机号
email	string	否	邮箱
type	string	是	类型：mobile\|email
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

Headers

Authorization

参数 / 正文

mobile

type

newpassword

captcha

响应输出

返回参数

无

无

POST 用户是否设置过密码 /api/user/userpwd

用户是否设置过密码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
account	string	是	账号（可使用账号，用户名，邮箱，手机号）

正文

无

Headers

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 设置或修改密码 /api/user/changepwd

设置或修改密码

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
oldpassword	string	否	旧密码，手机注册新用户不传
newpassword	string	是	新密码
renewpassword	string	是	重复新密码

正文

无

Headers

token

Authorization

参数 / 正文

oldpassword

newpassword

renewpassword

响应输出

返回参数

无

无

POST 查询登录用户权限 /api/user/get_user_rules

查询登录用户权限

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 查询用户信息 /api/user/get_user_info

查询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

token

Authorization

参数 / 正文

field

value

响应输出

返回参数

无

无

POST 查询登录用户的行为日志 /api/user/get_user_logs

查询登录用户的行为日志

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

token

Authorization

参数 / 正文

type

staff_id

limit

page

响应输出

返回参数

无

无

POST 第三方登录 /api/user/third_login

第三方登录

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
code	string	是	Code码
pid	string	否	上级用户UID，默认为0

正文

无

Headers

Authorization

参数 / 正文

code

pid

响应输出

返回参数

无

无

POST 第三方获取用户授权信息 /api/user/third_userinfo

第三方获取用户授权信息

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
openid	string	是	用户openid
detail	string	是	微信参数

正文

无

Headers

Authorization

参数 / 正文

openid

detail

响应输出

返回参数

无

无

POST 第三方获取用户手机 /api/user/third_getPhoneNumber

第三方获取用户手机

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
code	string	是	手机号快速验证Code码

正文

无

Headers

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 第三方用户手机登录 /api/user/third_getPhoneNumberLogin

openid用户不存在则新建，用户存在但手机不同则换绑

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述	示例
code	string	是	手机号快速验证Code码
openid	string	是	用户openid

正文

无

Headers

Authorization

参数 / 正文

code

openid

响应输出

返回参数

无

无

POST 第三方账号绑定用户中心 /api/user/third_binduser

第三方账号绑定用户中心

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述
openid	string	是	用户openid
account	string	是	用户名/邮箱/手机
password	string	是	密码

正文

无

Headers

Authorization

参数 / 正文

openid

account

password

响应输出

返回参数

无

无

POST 第三方手机验证码绑定 /api/user/third_mobilelogin

用户不存在则新建

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844; corporation_guid=53b5e5d4466712c7;）app_guid当前应用guid，corporation_guid当前登录的企业guid（不传则获取默认登录企业）

参数

名称	类型	必选	描述
openid	string	是	用户openid
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

Headers

Authorization

参数 / 正文

openid

mobile

captcha

响应输出

返回参数

无

无

POST 第三方账号解绑 /api/user/third_unbind

第三方账号解绑

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
openid	string	是	用户openid

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 生成用户密码 /api/user/gene_password

生成用户密码

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
user_guid	string	是	用户guid
password	string	是	密码

正文

无

Headers

token

Authorization

参数 / 正文

user_guid

password

响应输出

返回参数

无

无

GET 查询用户消息列表 /api/user/msg_list

查询用户消息列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
limit	int	否	每页数量，默认10
page	int	否	页码，默认1
status	int	否	查询的消息状态，默认全部，1未删除，0已删除

正文

无

Headers

token

Authorization

参数 / 正文

limit

page

status

响应输出

返回参数

无

无

POST 标记单条消息为已读 /api/user/read_message

标记单条消息为已读

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
id	int	是	消息id

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 标记全部消息为已读 /api/user/read_all_messages

标记全部消息为已读

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 删除指定消息 /api/user/del_message

删除指定消息

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
id	int	是	消息id

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 获取用户未读消息数量 /api/user/get_unread_count

获取用户未读消息数量

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 向指定用户发送点对点消息 /api/user/inform

向指定用户发送点对点消息

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
uid	string	是	接收消息的用户uid，如：10
msg	string	是	消息内容

正文

无

Headers

token

Authorization

参数 / 正文

uid

msg

响应输出

返回参数

无

无

POST 向多个用户群发消息 /api/user/inform_group

向多个用户群发消息

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
uids	string	是	接收消息的用户uids，英文逗号隔开，如：1,2,3
msg	string	是	消息内容

正文

无

Headers

token

Authorization

参数 / 正文

uids

msg

响应输出

返回参数

无

无

POST 向多个员工群发消息 /api/user/inform_staffs

向多个员工群发消息

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
staff_guids	string	是	接收消息的员工guid，英文逗号隔开，如：xxxx,yyyy
msg	string	是	消息内容

正文

无

Headers

token

Authorization

参数 / 正文

staff_guids

msg

响应输出

返回参数

无

无

POST 向多个部门群发消息 /api/user/inform_departments

向多个部门群发消息

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
department_guids	string	是	接收消息的部门guid，英文逗号隔开
msg	string	是	消息内容

正文

无

Headers

token

Authorization

参数 / 正文

department_guids

msg

响应输出

返回参数

无

无

POST 向企业员工群发消息 /api/user/inform_corporation

向企业员工群发消息

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
corporation_guid	string	是	接收消息的企业guid
msg	string	是	消息内容

正文

无

Headers

token

Authorization

参数 / 正文

corporation_guid

msg

响应输出

返回参数

无

无

Token

POST 检测Token是否过期 /api/token/check

检测Token是否过期

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 刷新Token /api/token/refresh

原Token失效，替换为新Token再进行后续操作

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

验证

POST 检测邮箱 /api/validate/check_email_available

检测邮箱

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
email	string	是	邮箱
id	string	是	排除会员ID

正文

无

Headers

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 检测用户名 /api/validate/check_username_available

检测用户名

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
username	string	是	用户名
id	string	是	排除会员ID

正文

无

Headers

Authorization

参数 / 正文

username

响应输出

返回参数

无

无

POST 检测手机号是否占用 /api/validate/check_mobile_available

检测手机号是否占用

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
mobile	string	是	手机号
id	string	是	排除会员ID

正文

无

Headers

Authorization

参数 / 正文

mobile

响应输出

返回参数

无

无

POST 检测手机号是否存在 /api/validate/check_mobile_exist

检测手机号是否存在

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
mobile	string	是	手机号

正文

无

Headers

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 检测邮箱 /api/validate/check_email_exist

检测邮箱

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
mobile	string	是	邮箱

正文

无

Headers

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 检测手机验证码 /api/validate/check_sms_correct

检测手机验证码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码
event	string	是	事件

正文

无

Headers

Authorization

参数 / 正文

mobile

captcha

event

响应输出

返回参数

无

无

POST 检测邮箱验证码 /api/validate/check_ems_correct

检测邮箱验证码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码
event	string	是	事件

正文

无

Headers

Authorization

参数 / 正文

captcha

event

响应输出

返回参数

无

无

手机短信

POST 发送验证码 /api/sms/send

同一个签名，对同一个手机号的发送频率：1分钟内短信发送条数不超过1条，1小时内短信发送条数不超过5条，1个自然日内短信发送条数不超过10条

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
mobile	string	是	手机号
event	string	是	事件名称：register注册/mobilelogin手机登录（自动注册）/changemobile修改手机/resetpwd修改密码

正文

无

Headers

Authorization

参数 / 正文

mobile

event

响应输出

返回参数

无

无

POST 检测验证码 /api/sms/check

检测验证码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称
captcha	string	是	验证码

正文

无

Headers

Authorization

参数 / 正文

mobile

event

captcha

响应输出

返回参数

无

无

POST 发送通知短信 /api/sms/notice

发送通知短信

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

Authorization

参数 / 正文

mobile

event

content

响应输出

返回参数

无

无

POST 企业信使短信发送 /api/sms/send_9002

企业信使短信发送

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
mobile	string	是	手机号
content	string	是	短信内容

正文

无

Headers

Authorization

参数 / 正文

mobile

content

响应输出

返回参数

无

无

邮箱验证码

POST 发送验证码 /api/ems/send

发送验证码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
email	string	是	邮箱
event	string	是	事件名称：register注册/changeemail更改邮箱/resetpwd用邮箱重置密码/changepwd

正文

无

Headers

Authorization

参数 / 正文

event

响应输出

返回参数

无

无

POST 检测验证码 /api/ems/check

检测验证码

Headers

名称	类型	必选	描述
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称
captcha	string	是	验证码

正文

无

Headers

Authorization

参数 / 正文

event

captcha

响应输出

返回参数

无

无

微服务-平台高级管理

GET 显示平台列表 /api/paas/platform

显示平台列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述
limit	integer	否	每页数量，默认10
page	integer	否	页码，默认1
search	string	否	根据平台名模糊搜索

正文

无

Headers

token

Authorization

参数 / 正文

limit

page

响应输出

返回参数

无

无

GET 显示全部平台列表 /api/paas/platform_map

显示全部平台列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 新增平台 /api/paas/platform

新增平台

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
name	string	是	平台名称

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

GET 显示指定的平台 /api/paas/platform/{id}

显示指定的平台

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
id	string	是	平台guid

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

PUT 更新平台 /api/paas/platform/{id}

注意：仅传需更新的字段

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
name	string	是	平台名称	江苏省农科院
id	string	是	平台guid	xxxxx
token_keeptime	number	否	平台token有效期，填0或不传默认7200（单位：秒）

正文

无

Headers

token

Authorization

参数 / 正文

name

token_keeptime

响应输出

返回参数

无

无

DELETE 删除指定平台 /api/paas/platform/{id}

删除指定平台

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
id	string	是	平台guid

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

PUT 更新平台管理员 /api/paas/platform_admin

支持批量更新，平台管理员可管理平台内应用、企业、用户，可接管企业

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
platform_guid	string	是	平台guid	86c5ed47106c9003
user_list	object	是	用户与管理等级（集合），字段user_id为用户id，字段level为管理等级（1超管 2普通管理员，一个平台只允许存在一个超管）	[{'user_id':2,'level':1},{'user_id':9,'level':2}]

正文

无

Headers

token

Authorization

参数 / 正文

platform_guid

user_list

响应输出

返回参数

无

无

GET 显示指定平台企业套餐 /api/paas.paas_platform/pass_platform_packs

显示指定平台企业套餐

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844;）

参数

名称	类型	必选	描述	示例
platform_guid	string	是	平台guid	3dc5e5d305504be4

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

PUT 更新指定平台可用企业套餐 /api/paas.paas_platform/pass_platform_packs_update

更新指定平台可用企业套餐

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844;）

参数

名称	类型	必选	描述	示例
platform_guid	string	是	平台guid	86c5ed47106c9003
pack_ids	string	是	套餐ids，英文逗号隔开，通过get显示全部企业套餐列表/api/paas.paas_platform/pass_packs_map接口获取套餐名称和id的键值对	1,2,3,4,5,6,7,8,9,10

正文

无

Headers

token

Authorization

参数 / 正文

platform_guid

pack_ids

响应输出

返回参数

无

无

GET 显示企业套餐列表 /api/paas.paas_platform/pass_packs

显示企业套餐列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844;）

参数

名称	类型	必选	描述	示例
search	string	否	套餐名称、标题、描述内容模糊搜索	测试
limit	integer	否	每页数量，默认10	10
page	integer	否	页码，默认1	1
order	string	否	排序，asc正序，desc倒序，默认desc	asc

正文

无

Headers

token

Authorization

参数 / 正文

limit

page

order

响应输出

返回参数

无

无

GET 显示全部企业套餐列表 /api/paas.paas_platform/pass_packs_map

显示全部企业套餐列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=40d5e7c7b22de844;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

GET 显示指定的企业套餐 /api/paas.paas_platform/get_pass_pack

显示指定的企业套餐

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
id	integer	是	套餐id	1

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 新增企业套餐 /api/paas.paas_platform/pass_pack_save

新增企业套餐

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
name	string	是	套餐名	1号平台知麦专用无敌超管套餐
subtitle	string	否	套餐标题	无敌超管套餐
icon	string	否	套餐图标，url或css样式	https://url或icon-tel
icon_color	string	否	图标颜色（RGB或16进制）	#ff0101
servers	string	否	套餐微服务ids，逗号隔开，通过get全部微服务列表/api/imse/index_map接口获取微服务名称和id的键值对	1,2,3,4,5,6,7,8,9,10
config	object	否	套餐配置，保留字段	{'test':'abc','test1':true}
price	string	否	套餐现价/折扣价（元/月）	520
original_price	string	否	套餐原价（元/月）	1314.52

正文

无

Headers

token

Authorization

参数 / 正文

name

subtitle

icon

icon_color

servers

config

price

original_price

响应输出

返回参数

无

无

PUT 更新企业套餐 /api/paas.paas_platform/pass_pack_update

注意：仅传需更新的字段

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
id	integer	是	套餐id	1
name	string	否	套餐名	1号平台知麦专用无敌超管套餐
subtitle	string	否	套餐标题	无敌超管套餐
icon	string	否	套餐图标，url或css样式	https://url或icon-tel
icon_color	string	否	图标颜色（RGB或16进制）	#ff0101
servers	string	否	套餐微服务ids，逗号隔开，通过get全部微服务列表/api/imse/index_map接口获取微服务名称和id的键值对	1,2,3,4,5,6,7,8,9,10
config	object	否	套餐配置，保留字段	{'test':'abc','test1':true}
price	string	否	套餐现价/折扣价（元/月）	520
original_price	string	否	套餐原价（元/月）	1314.52
desc	string	否	套餐描述（富文本）	<p></p>

正文

无

Headers

token

Authorization

参数 / 正文

name

subtitle

icon

icon_color

servers

config

price

original_price

desc

响应输出

返回参数

无

无

DELETE 删除指定企业套餐 /api/paas.paas_platform/pass_pack_delete

删除指定企业套餐

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
id	integer	是	套餐id	1

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

GET 显示应用列表 /api/paas/platform_app

显示应用列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
app_type	string	否	应用类型，web（网站）或third_app（第三方应用）	third_app
search	string	否	应用名称、描述、url、appid、account、gh_id、appsecret等字段模糊搜索	物联网
limit	integer	否	每页数量，默认10	10
page	integer	否	页码，默认1	1

正文

无

Headers

token

Authorization

参数 / 正文

app_type

limit

page

响应输出

返回参数

无

无

GET 显示应用帮助手册 /api/paas/app_help

显示应用帮助手册

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
app_guid	string	否	应用guid，不传则默认当前应用	xxxxx

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

PUT 更新应用帮助手册 /api/paas/app_help

更新应用帮助手册

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

token

Authorization

参数 / 正文

app_guid

content

响应输出

返回参数

无

无

POST 新增应用 /api/paas/platform_app

新增应用

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

token

Authorization

参数 / 正文

platform_guid

app_type

title

desc

url

third_id

account

appid

appsecret

gh_id

响应输出

返回参数

无

无

PUT 编辑WEB应用 /api/paas/platform_app_web

编辑WEB应用

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
platform_guid	string	是	应用所属平台guid	86c5ed47106c9003
app_guid	string	是	应用guid	xxxxx
title	string	是	应用标题	鸿景物联溯源（发布版）
desc	string	是	应用描述	鸿景物联溯源（发布版）
url	string	否	网站域名，应用类型为web必填	http://www.xxx.com

正文

无

Headers

token

Authorization

参数 / 正文

platform_guid

app_guid

title

desc

url

响应输出

返回参数

无

无

PUT 编辑第三方应用 /api/paas/platform_app_third

编辑第三方应用

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
platform_guid	string	是	应用所属平台guid	86c5ed47106c9003
app_guid	string	是	应用guid	xxxxx
title	string	是	应用标题	鸿景物联溯源（发布版）
desc	string	是	应用描述	鸿景物联溯源（发布版）
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
path	string	否	第三方应用入口路由地址	pages/index/index

正文

无

Headers

token

Authorization

参数 / 正文

platform_guid

app_guid

title

desc

third_id

account

appid

appsecret

gh_id

path

响应输出

返回参数

无

无

DELETE 删除指定应用 /api/paas/platform_app

删除指定应用

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
app_guid	string	是	app_guid	e695e7c856324575

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

GET 显示企业隐藏超管列表 /api/paas/virtual_admin

显示企业隐藏超管列表

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

DELETE 删除企业隐藏超管 /api/paas/virtual_admin

删除企业隐藏超管

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
staff_id	integer	是	员工id	2

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 禁用企业隐藏超管 /api/paas/virtual_admin_disable

禁用企业隐藏超管

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
staff_id	integer	是	员工id	2

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 新增企业隐藏超管 /api/paas/virtual_admin

新增企业隐藏超管

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
corporation_guid	string	是	企业guid	xxxxxx

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 清空所有用户token（慎用） /api/paas/clear_all_token

平台超管可清空所有用户token

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
platform_guid	string	是	平台guid	86c5ed47106c9003

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 清空指定用户token（慎用） /api/paas/clear_token

平台超管可清空指定用户token

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;），其中app_guid必须是中心超管应用

参数

名称	类型	必选	描述	示例
platform_guid	string	是	平台guid	86c5ed47106c9003
user_id	integer	是	用户id	1111

正文

无

Headers

token

Authorization

参数 / 正文

platform_guid

user_id

响应输出

返回参数

无

无

微服务-平台基础管理

GET 显示平台面板数据 /api/paas/platform_panel

显示平台面板数据

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

无

正文

无

Headers

token

Authorization

参数 / 正文

响应输出

返回参数

无

无

POST 接管企业 /api/paas/control_corporation

接管企业

Headers

名称	类型	必选	描述
token	string	是	请求的Token
Authorization	string	是	请求的Authorization（例：app_guid=xxxxxx;）

参数

名称	类型	必选	描述	示例
corporation_guid	string	是	要接管的企业guid	xxxxxx

正文

无