Files

key fb65dceaa0 feat: 切换到商户号子账号登录端点 + 项目清理

- AuthService: 改用 http://common.apifm.com/loginAdmin/operator/v2 商户号登录
  * 验证码和登录统一使用该主机以保持 JSESSIONID 一致
  * 改用 FormUrlEncodedContent POST body
  * 未配置 MerchantId 时回退到旧的 pdomain 登录方式
- AppConfig: 新增 MerchantId 配置项
- App.config: 新增 MerchantId=15073
- LoginViewModel: captchaKey 由 GUID 改为 JS Math.random 风格 0.xxx
- setup.iss: 修复 GBK 编码损坏导致的字符串未闭合错误，改为 UTF-8 BOM
- README: 更新配置示例与相关文档链接
- .gitignore: 忽略 .env 本地密钥文件
- 清理过时/无关文档与未引用的 SFX 打包脚本

2026-04-17 12:03:15 +08:00

439 KiB

Raw Permalink Blame History

Apifm-common

简介:Apifm-common

HOST:http://common.apifm.com

联系人:gooking

Version:v1.0.0

接口路径:/v3/api-docs/后台接口

[TOC]

设置类接口

获得购买vip地址信息

接口地址:/vip/getPayData

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

userId 和 mobile 只要传一个即可

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	商户编号	query	true	integer(int32)
mobile	商户手机号码	query	true	string
vipLevel		query	true	integer(int32)
payType	alipay wx	query	true	string
apiPriceId	模块所对应的套餐ID	query	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

使用vip卡券激活(续费)

接口地址:/vip/card

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

userId 和 mobile 只要传一个即可

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	商户编号	query	true	integer(int32)
mobile	商户手机号码	query	true	string
number	vip卡券的卡密	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

运营商的客户自己续费链接

接口地址:/vip/agent/getPayData

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

userId 和 mobile 只要传一个即可

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	商户编号	query	true	integer(int32)
mobile	商户手机号码	query	true	string
type	1 按年； 2 按月	query	true	integer(int32)
number	购买几年（月）	query	true	integer(int32)
payType	alipay wx	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设置标签机标签纸尺寸

接口地址:/apifmUser/set/printerFeie/setLabelPrinterSize

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录ID	query	true	integer(int32)
width	宽度	query	true	integer(int32)
height	高度	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

清空打印任务

接口地址:/apifmUser/set/printerFeie/clearTask

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

图片验证码设置

接口地址:/apifmUser/picCodeConfig/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
str	包含字符	query	true
strLength	验证码长度	query	true
width	图片宽度	query	true
height	图片高度	query	true
isAddEfect	是否添加干扰效果，0 不加，1加	query	true
lineSpace	干扰线间距	query	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

系统参数设置

接口地址:/apifmUser/configBase/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
content	参数值	query	true	string
X-Token	管理员登录凭证	header	true
dateType	类型：0 文本字符串 1 开关 2 上传文件	query	true
key	参数编码	query	true
id	添加不传；修改传需要修改的记录id	query	false
isPub	是否公开还是隐私，true/false	query	false
remark	备注	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改参数设置

接口地址:/apifmUser/configBase/modify

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
key	参数编码	query	true	string
content	参数值	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

系统参数设置列表

接口地址:/apifmUser/configBase/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
creatAtBegin	更新时间起,格式 2018-05-16	query	true	string
creatAtEnd	更新时间止,格式 2018-05-16	query	true	string
updateAtBegin		query	true	string
updateAtEnd		query	true	string
X-Token	管理员登录凭证	header	true
isPub	是否公开还是隐私，true/false	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除系统参数

接口地址:/apifmUser/configBase/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	删除的记录id，多个id之间用英文的逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

扩展地址添加-编辑

接口地址:/apifmUser/centerUserAddress/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号,修改的时候需要传	query	false
provinceId	省份编码	query	false
cityId	城市编码	query	false
districtId	区县编码	query	false
address	详细地址	query	false
addressEn	英文详细地址	query	false
addressEn2	英文详细地址	query	false
addressEn3	英文详细地址	query	false
addressEn4	英文详细地址	query	false
addressEn5	英文详细地址	query	false
addressEn6	英文详细地址	query	false
addressEn7	英文详细地址	query	false
addressEn8	英文详细地址	query	false
latitude	地图纬度	query	false
longitude	地图经度	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

扩展地址列表

接口地址:/apifmUser/centerUserAddress/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
addressLike	中文地址模糊搜索	query	true	string
addressEnLike	英文地址模糊搜索	query	true	string
addressEn2Like	英文地址模糊搜索	query	true	string
addressEn3Like	英文地址模糊搜索	query	true	string
addressEn4Like	英文地址模糊搜索	query	true	string
addressEn5Like	英文地址模糊搜索	query	true	string
addressEn6Like	英文地址模糊搜索	query	true	string
addressEn7Like	英文地址模糊搜索	query	true	string
addressEn8Like	英文地址模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除扩展地址

接口地址:/apifmUser/centerUserAddress/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取飞鹅打印机状态

接口地址:/apifmUser/set/printerFeie/status

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

1、离线。2、在线，工作状态正常。3、在线，工作状态不正常。备注：异常一般是无纸，离线的判断是打印机与服务器失去联系超过2分钟。

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

飞鹅打印机列表

接口地址:/apifmUser/set/printerFeie/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取图片验证码设置

接口地址:/apifmUser/picCodeConfig/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

批量获取多个参数设置值

接口地址:/apifmUser/configBase/values

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
key	参数值,多个key用英文逗号隔开	query	true	array	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

系统参数设置详情

接口地址:/apifmUser/configBase/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

扩展地址详情

接口地址:/apifmUser/centerUserAddress/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

登录及授权

注册获取短信验证码

接口地址:/registerAdmin/smscode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	不传为 apifm	query	true	string
mobile	手机号码	query	true	string
code	图形验证码	query	true	string
k	验证码随机数	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

注册保存【手机方式】

接口地址:/registerAdmin/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	不传为 apifm	query	true	string
mobile	手机号码	query	true	string
pwd	登录密码	query	true	string
name	姓名/昵称	query	true	string
smsCode	短信验证码	query	true	string
referrer	推荐人用户ID	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

注册保存【邮箱方式】

接口地址:/registerAdmin/save/email

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
email	邮箱	query	true	string
pwd	登录密码	query	true	string
name	姓名/昵称	query	true	string
mailCode	邮箱验证码	query	true	string
referrer	推荐人用户ID	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

注册获取邮箱验证码

接口地址:/registerAdmin/mailcode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
email	电子邮箱	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

子账号登录[域名]

接口地址:/loginAdmin/userName/v2

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

该接口会优先判断手机号码登录，如果满足直接登录成功，其次才会尝试子账号登录

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userName	用户名	query	true	string
pwd	登录密码	query	true	string
rememberMe	是否记住密码	query	true	string
pdomain	专属域名	query	true	string
imgcode	图形验证码	query	true	string
k	验证码随机数	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

通过前端用户的token换取X-TOKEN

接口地址:/loginAdmin/token

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
token	前端用户登陆的token	query	true	string
id	管理员ID，可以指定换取某个管理员，不传该参数会返回所有管理员列表	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店登陆接口

接口地址:/loginAdmin/shop

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

使用门店管理里面的用户名和密码进行登陆

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
username	用户名	query	true	string
pwd	登录密码	query	true	string
pdomain	专属域名	query	true	string
code	小程序login接口获取到的临时凭证 code；如果传了，登陆以后绑定openid，后续可实现自动登陆	query	true	string
appid	对应小程序的appID；如果传了，登陆以后绑定openid，后续可实现自动登陆	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

子账号登录[商户号]

接口地址:/loginAdmin/operator/v2

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

前5次登陆如果没传验证码，忽略验证码验证，一小时内连续错误5次以后，必须要提供验证码

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userName	用户名	query	true	string
pwd	登录密码	query	true	string
rememberMe	是否记住密码	query	true	string
merchantId	商户编号	query	true	integer(int32)
imgcode	图形验证码	query	true	string
k	验证码随机数	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

手机号码登录

接口地址:/loginAdmin/mobile/v2

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

前5次登陆如果没传验证码，忽略验证码验证，一小时内连续错误5次以后，必须要提供验证码

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
mobile	手机号码	query	true	string
pwd	登录密码	query	true	string
rememberMe	是否记住密码	query	true	string
imgcode	图形验证码	query	true	string
k	验证码随机数	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

通过商户号和秘钥登录获取X-TOKEN

接口地址:/loginAdmin/key

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
merchantNo	商户号	query	true	string
merchantKey	商户秘钥	query	true	string
rememberMe	是否记住密码	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

邮箱登录获取X-TOKEN

接口地址:/loginAdmin/email

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
email	电子邮箱	query	true	string
pwd	登录密码	query	true	string
rememberMe	是否记住密码	query	true	string
imgcode	图形验证码	query	true	string
k	验证码随机数	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

忘记密码发送短信验证码

接口地址:/forgetPassword/smscode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	不传为 apifm	query	true	string
mobile	手机号码	query	true	string
code	图形验证码	query	true	string
k	验证码随机数	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

重置新密码

接口地址:/forgetPassword/resetPwd

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	不传为 apifm	query	true	string
mobile	手机号码	query	true	string
pwd	新密码	query	true	string
smsCode	短信验证码	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

重置新密码【通过邮件验证码】

接口地址:/forgetPassword/resetPwd/mail

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
type	不传为 apifm	query	true	string
email	手机号码	query	true	string
pwd	新密码	query	true	string
mailCode	邮件验证码	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改登录密码

接口地址:/apifmUser/editPwd/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
oldPwd	原密码	query	true	string
newPwd	新密码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改角色

接口地址:/apifmUser/centerUserRoles/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
actionsIds	允许的权限ID	query	true	array	integer
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
name	角色名称	query	false
profile	角色描述	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

所有的角色列表

接口地址:/apifmUser/centerUserRoles/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除角色

接口地址:/apifmUser/centerUserRoles/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	角色ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

启用管理员

接口地址:/apifmUser/admin/unstop

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	管理员ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

禁用管理员

接口地址:/apifmUser/admin/stop

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	管理员ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改管理员

接口地址:/apifmUser/admin/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
roleIds	角色ID	query	true	array	integer
X-Token	管理员登录凭证	header	true
id	管理员ID，修改时候传	query	false
username	用户名	query	false
pwd	密码	query	false
realname	姓名	query	false
shopIds	门店管理员的话，拥有权限的门店ID，多个门店之间用英文逗号分隔	query	false
logo	自定义字段，长度200	query	false
cover	自定义字段，长度200	query	false
stamp	自定义字段，长度200	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

重置管理员密码

接口地址:/apifmUser/admin/resetPwd

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	管理员ID	query	true	integer(int32)
pwd	新密码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

区域管理员列表

接口地址:/apifmUser/admin/quyu

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

平台管理员列表

接口地址:/apifmUser/admin/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除管理员

接口地址:/apifmUser/admin/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	管理员id，多个数字用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

退出登录

接口地址:/loginAdmin/exit

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
xtoken	当前登录的后台xtoken	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取角色详情

接口地址:/apifmUser/centerUserRoles/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	角色ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取所有的权限列表

接口地址:/apifmUser/centerUserRoles/actions

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

管理员详情

接口地址:/apifmUser/admin/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	管理员ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

插件管理

获得购买插件信息

接口地址:/buy/plugin/getPayData

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	商户编号	query	true	integer(int32)
mobile	商户手机号码	query	true	string
type	购买的插件类型	query	true	integer(int32)
payType	alipay wx	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

工厂设置

获得购买模块套餐信息

接口地址:/buy/centerUserApi/getPayData

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

userId 和 mobile 只要传一个即可

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
userId	商户编号	query	true	integer(int32)
mobile	商户手机号码	query	true	string
apiPriceId	模块所对应的套餐ID	query	true	integer(int32)
payType	alipay wx	query	true	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取所有工厂模块列表

接口地址:/apis/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	关键词	query	true	string
isShow	是否显示所有模块（否则同一个分组仅展示一个模块）	query	false
groupName	接口分组	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

vip卡券列表

接口地址:/apifmUser/vipCard/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

推广返佣申请提现

接口地址:/apifmUser/spread/apply

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
amount	提现金额	query	true	number
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设置推广返佣支付宝账号

接口地址:/apifmUser/spread/alipay

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
alipay	支付宝账号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改我的客户信息

接口地址:/apifmUser/centerUser/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
dateExt1Str	自定义时间，比如自定义客户的到期时间	query	true	string
X-Token	管理员登录凭证	header	true
id	添加不传；修改传需要修改的用户id	query	false
pwd	密码，添加时候必传，修改的时候可以不传	query	false
domain	专属域名，例如 http://aaa.bbb.com，这里只要传 aaa 即可	query	false
realName	真实姓名	query	false
status	状态:-1 删除 0 默认 1 禁用 2 密码锁定	query	false
remark2	自定义备注信息	query	false
priceYear	客户年费金额	query	false
priceMonth	客户月费金额	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

我的客户列表

接口地址:/apifmUser/centerUser/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	开通时间起,格式 2018-05-16	query	true	string
dateAddEnd	开通时间止,格式 2018-05-16	query	true	string
realNameLike	真实姓名	query	true	string
orderBy	排序规则：idAsc 开户时间早优先，idDesc 开户时间晚优先，loginAsc 登陆时间早优先，loginDesc 登陆时间晚优先，dateExt1Asc 自定义时间早优先，dateExt1Desc 自定义时间晚优先	query	true	string
X-Token	管理员登录凭证	header	true
mobile	用户名	query	false
merchantNo	商户号	query	false
domain	域名	query	false
status	状态:-1 删除 0 默认 1 禁用 2 密码锁定	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除我的客户

接口地址:/apifmUser/centerUser/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	用户ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

卸载模块

接口地址:/apifmUser/apiCenterUser/uninstall

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	模块ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

一键移除所有模块

接口地址:/apifmUser/apiCenterUser/removeAll

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

已安装模块列表

接口地址:/apifmUser/apiCenterUser/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

安装模块

接口地址:/apifmUser/apiCenterUser/install

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	模块ID，多个模块用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

我开通的插件列表

接口地址:/apifmUser/pluginInfo/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

检测是否开通了某插件

接口地址:/apifmUser/pluginInfo/check

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	插件类型编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

我的客户详情

接口地址:/apifmUser/centerUser/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	客户用户ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

暂时模块可购买的套餐列表

接口地址:/apifmUser/apiCenterUser/buy

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	模块ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约报名

预约-报名设置为报名成功

接口地址:/apifmUser/yuyueJoin/success

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	报名ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约-报名记录标记为已服务

接口地址:/apifmUser/yuyueJoin/servered

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	报名ID，多个ID用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约-报名用户管理

接口地址:/apifmUser/yuyueJoin/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	报名时间起,格式 2018-05-16	query	true	string
dateAddEnd	报名时间止,格式 2018-05-16	query	true	string
mobile	用户手机号码	query	true	string
nick	用户昵称	query	true	string
showExtJson	显示扩展属性	query	true	boolean
X-Token	管理员登录凭证	header	true
id	预约ID	query	false
yuyueId	预约项目编号	query	false
teamId	团队ID	query	false
status	状态：'0 等待付款 1 报名成功	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约-报名记录删除

接口地址:/apifmUser/yuyueJoin/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	报名ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

取消预约

接口地址:/apifmUser/yuyueJoin/cancel

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	报名ID	query	true	integer(int64)
refund	是否退还报名费, true / false	query	true	boolean
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约报名设置添加-修改

接口地址:/apifmUser/yuyueInfo/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pics	图片数组	query	true	array	string
dateBeginStr	报名开始时间,格式：yyyy-MM-dd HH:mm:ss	query	true	string
dateEndStr	报名截止时间,格式：yyyy-MM-dd HH:mm:ss	query	true	string
activityTimeStr	活动时间,格式：yyyy-MM-dd HH:mm:ss	query	true	string
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
id	添加不传；修改传需要修改的记录id	query	false
title	标题	query	false
isRecommend	是否推荐：true 推荐 / false 不推荐	query	false
descript	描述	query	false
content	详细说明	query	false
isMemberLimit	是否仅限会员报名 true/false	query	false
vipLevel	isMemberLimit = true 下生效，指定会员等级限制	query	false
numberMax	最多预约报名人数	query	false
amount	预约报名需要支付的金额	query	false
status	状态：0开启；1关闭	query	false
limitUserTotal	0 为不限，每个用户最多可投几次	query	false
limitUserDay	0 为不限，每个用户每天最多可投几次	query	false
scoreSend	成功报名/预约奖励积分数	query	false
scoreComplete	活动完成后奖励积分数	query	false
address	活动地点	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约报名数据列表

接口地址:/apifmUser/yuyueInfo/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间止,格式 2018-05-16	query	true	string
dateUpdateBegin		query	true	string
dateUpdateEnd		query	true	string
dateBeginBegin	开始时间起,格式 2018-05-16	query	true	string
dateBeginEnd	开始时间止,格式 2018-05-16	query	true	string
dateEndBegin	截止时间起,格式 2018-05-16	query	true	string
dateEndEnd	截止时间止,格式 2018-05-16	query	true	string
titleLike	名称模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
id	编号	query	false
shopId	所属店铺	query	false
categoryId	分类ID	query	false
isRecommend	是否推荐：true 推荐 / false 不推荐	query	false
status	状态：'0 开启 1 关闭	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除预约报名项目

接口地址:/apifmUser/yuyueInfo/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

预约报名信息详情

接口地址:/apifmUser/yuyueJoin/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	报名ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取预约报名项目详情

接口地址:/apifmUser/yuyueInfo/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信服务商

删除指定的模版库

接口地址:/apifmUser/wxopenapp/template/deletetemplate

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
appid	应用的appid	query	true	string
templateId	模版id	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

开发版添加至模版库

接口地址:/apifmUser/wxopenapp/template/addtotemplate

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
appid	应用的appid	query	true	string
draftId	开发版模版id	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信服务商应用设置

接口地址:/apifmUser/wxopenapp/setting/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号，不传为添加，传了为更新	query	true
name	服务商应用名称	query	false
appid	服务商应用的APPID	query	false
secret	服务商应用的APPSECRET	query	false
token	消息校验Token	query	false
aeskey	消息加解密Key	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信服务商快速创建小程序

接口地址:/apifmUser/wxopenapp/setting/fastregister

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/Register_Mini_Programs/Fast_Registration_Interface_document.html

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
name	企业名（需与工商部门登记信息一致）	query	true	string
code	企业代码	query	true	string
codeType	企业代码类型 1：统一社会信用代码（18 位） 2：组织机构代码（9 位 xxxxxxxx-x） 3：营业执照注册号(15 位)	query	true	integer(int32)
legalPersonaWechat	法人微信号	query	true	string
legalPersonaName	法人姓名（绑定银行卡）	query	true	string
componentPhone	第三方联系电话（方便法人与第三方联系）	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信服务商快速创建小程序状态查询

接口地址:/apifmUser/wxopenapp/setting/fastregister/query

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
name	企业名（需与工商部门登记信息一致）	query	true	string
legalPersonaWechat	法人微信号	query	true	string
legalPersonaName	法人姓名（绑定银行卡）	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除微信服务商应用设置

接口地址:/apifmUser/wxopenapp/setting/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号上传代码

接口地址:/apifmUser/wxopenapp/app/uploadCode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
templateId	代码库模版编号	query	true	string
extJsonStr	自定义的配置	query	true	string
userVersion	代码版本号	query	true	string
userDesc	代码描述	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

小程序撤回审核

接口地址:/apifmUser/wxopenapp/app/undocodeaudit

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

小程序提交审核

接口地址:/apifmUser/wxopenapp/app/submitAudit

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

小程序加急审核

接口地址:/apifmUser/wxopenapp/app/speedupaudit

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号添加业务域名

接口地址:/apifmUser/wxopenapp/app/setwebviewdomain

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
webviewdomain	小程序业务域名，多个用英文逗号分隔	query	true	array	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号设置小程序名称

接口地址:/apifmUser/wxopenapp/app/setnickname

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
nick_name	小程序名称	query	true	string
license	营业执照照片地址	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号设置服务器域名

接口地址:/apifmUser/wxopenapp/app/set/domain

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

授权公众号列表

接口地址:/apifmUser/wxopenapp/app/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
name	服务商应用名称	query	false
appid	服务商应用的APPID	query	false
secret	服务商应用的APPSECRET	query	false
token	消息校验Token	query	false
aeskey	消息加解密Key	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

发布审核通过的小程序

接口地址:/apifmUser/wxopenapp/app/release

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

配置小程序用户隐私保护指引

接口地址:/apifmUser/wxopenapp/app/privacysettingSave

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
privacy_ver	用户隐私保护指引的版本，1表示现网版本；2表示开发版。默认是2开发版。	query	true	integer(int32)
content_owner_setting	收集方（开发者）信息配置	query	true	string
content_setting_list	要收集的用户信息配置	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号添加插件

接口地址:/apifmUser/wxopenapp/app/pluginAdd

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
pluginAppid	插件的appid	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号设置简介

接口地址:/apifmUser/wxopenapp/app/modifysignature

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
signature	公众号功能介绍（简介）	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号修改头像

接口地址:/apifmUser/wxopenapp/app/modifyheadimage

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
head_img	头像图片地址	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

授权公众号列表

接口地址:/apifmUser/wxopenapp/app/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	公众号名称关键词	query	true	string
principalNameLike	主体名称关键词	query	true	string
X-Token	管理员登录凭证	header	true
componentAppid	服务商appid	query	false
appid	公众号appid	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除授权公众号

接口地址:/apifmUser/wxopenapp/app/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权小程序添加类目

接口地址:/apifmUser/wxopenapp/app/addcategory

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
first	一级类目ID	query	true	integer(int32)
second	二级类目ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

给授权公众号添加插件

接口地址:/apifmUser/wxopenapp/app/addExperienceUser

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
wechatid	用户的微信号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取模版库列表

接口地址:/apifmUser/wxopenapp/template/templatelist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appid	应用的appid	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取模版库开发版

接口地址:/apifmUser/wxopenapp/template/draftlist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
appid	应用的appid	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取运营商的微信服务商应用设置列表

接口地址:/apifmUser/wxopenapp/setting/parentList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信服务商应用设置列表

接口地址:/apifmUser/wxopenapp/setting/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信服务商应用设置详情

接口地址:/apifmUser/wxopenapp/setting/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

同步更新小程序信息

接口地址:/apifmUser/wxopenapp/app/refreshBasicinfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查询服务商的当月提审限额（quota）和加急次数

接口地址:/apifmUser/wxopenapp/app/queryquota

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取授权公众号体验二维码

接口地址:/apifmUser/wxopenapp/app/qrcode/experience

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查询小程序用户隐私保护指引

接口地址:/apifmUser/wxopenapp/app/privacysettingQuery

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录编号	query	true	integer(int32)
privacy_ver	用户隐私保护指引的版本，1表示现网版本；2表示开发版。默认是2开发版。	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

授权公众号详情

接口地址:/apifmUser/wxopenapp/app/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取可以设置的所有类目

接口地址:/apifmUser/wxopenapp/app/getallcategories

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查看小程序审核状态

接口地址:/apifmUser/wxopenapp/app/auditstatus

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信相关

修改公众号配置

接口地址:/apifmUser/wxMpSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
appid	appid	query	true
secret	secret	query	false
token	消息推送的token，一般不用配置	query	false
isCopy	是否是镜像配置，镜像配置的话系统会读主配置信息	query	false
allowCopyUserids	允许被镜像的商户IDS，多个商户ID用英文逗号分隔	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取二维码

接口地址:/apifmUser/wxMpSet/qrcode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
content	二维码参数，可不传	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除当前公众号配置

接口地址:/apifmUser/wxMpSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取公众号当前配置

接口地址:/apifmUser/wxMpSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信小程序

修改小程序配置

接口地址:/apifmUser/wxMiniprogramSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
protection	如果传true，除了当前小程序外别的小程序将无法访问所有接口	query	true	boolean
X-Token	管理员登录凭证	header	true
appid	appid	query	true
secret	secret	query	false
token	消息推送的token，一般不用配置	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取小程序二维码(正方形的)

接口地址:/apifmUser/wxMiniprogramSet/qrcode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
content	页面路径，如: pages/index/index	query	true	string
width	二维码的宽度	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取小程序当前配置

接口地址:/apifmUser/wxMiniprogramSet/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除当前小程序配置

接口地址:/apifmUser/wxMiniprogramSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

apifm收银机商户设置

接口地址:/apifmUser/cashRegisterSetting/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

财务相关

提现设置

接口地址:/apifmUser/withdrawalSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
feePercent	提现手续费（%）	query	true
minAmount	最少提现金额	query	true
timesPerDay	每天可提现次数	query	true
timesPerMonth	每月可提现次数	query	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除提现设置

接口地址:/apifmUser/withdrawalSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设为提现成功

接口地址:/apifmUser/withdrawalLog/success

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

撤回用户提现

接口地址:/apifmUser/withdrawalLog/refuse

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录ID	query	true	integer(int64)
rejectionReason	驳回原因	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

微信打款给用户

接口地址:/apifmUser/withdrawalLog/pay/wx

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录ID	query	true	integer(int64)
transferSceneId	转账场景ID: 现金营销(ID=1000);行政补贴(ID=1002);保险理赔(ID=1004);佣金报酬(ID=1005);采购货款(ID=1009);二手回收(ID=1010);企业赔付(ID=1011);公益补助(ID=1013)	query	true	string
userRecvPerception	用户收款时感知到的收款原因将根据转账场景自动展示默认内容。如有其他展示需求，可在本字段传入。各场景展示的默认内容和支持传入的内容，可查看, https://pay.weixin.qq.com/doc/v3/merchant/4012711988#3.3-%E5%8F%91%E8%B5%B7%E8%BD%AC%E8%B4%A6	query	true	string
content	转账场景报备信息，详见 https://pay.weixin.qq.com/doc/v3/merchant/4012711988#3.3-%E5%8F%91%E8%B5%B7%E8%BD%AC%E8%B4%A6	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户提现列表

接口地址:/apifmUser/withdrawalLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
dateUpdateBegin	更新时间起,格式 2018-05-16	query	true	string
dateUpdateEnd	更新时间起,格式 2018-05-16	query	true	string
mobileUser	用户手机号码	query	true	string
nick	用户昵称	query	true	string
X-Token	管理员登录凭证	header	true
uid	用户编号	query	false
number	提现编号	query	false
status	状态 0等待处理 1成功 2失败 3处理中	query	false
其他参数	用户提现记录表	query	false	WithdrawalLog	WithdrawalLog
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	用户ID		false	integer(int64)
userType	0 个人；1 企业		false	integer(int32)
name	姓名		false	string
mobile	手机号		false	string
number	订单号		false	string
money	提现金额（包含手续费）		false	number
moneyFee	手续费		false	number
tax	税款		false	number
txVersion	提现版本，1 为企业打款接口；2 为商家打款接口		false	integer(int32)
status	0等待处理 1成功 2失败 3处理中		false	integer(int32)
bankName	开户银行名称		false	string
bankBranch	开户行/支行		false	string
bankCardNumber	银行账号		false	string
remark	备注		false	string
dateAdd	申请时间		false	string(date-time)
dateUpdate	变更时间		false	string(date-time)
rejectionReason	驳回原因		false	string
transferSceneId	转账场景ID		false	string
userRecvPerception	用户收款感知		false	string
transferBillNo	三方订单号		false	string
packageInfo	微信转账的参数		false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

会员等级购买记录

接口地址:/apifmUser/userLevelBuyLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
mobile	用户手机号码	query	true	string
nick	用户昵称	query	true	string
X-Token	管理员登录凭证	header	true
uid	用户编号	query	false
orderNumber	订单号	query	false
levelId	会员等级ID	query	false
priceId	会员等级收费项目ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

调整用户成长值

接口地址:/apifmUser/growthLog/modifyGrowth

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
uid	用户编号(用户编号和手机号码至少传一项)	query	true	integer(int64)
mobile	手机号码(用户编号和手机号码至少传一项)	query	true	string
growth	调整数量(减少请填写负数)	query	true	number
remark	备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

成长值明细

接口地址:/apifmUser/growthLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	交易时间起	query	true	string
dateAddEnd	交易时间止	query	true	string
mobileUser	手机号码	query	true	string
nick	用户昵称	query	true	string
X-Token	管理员登录凭证	header	true
type	交易类型：0 管理员调整 1 积分兑换	query	false
behavior	0 收入 1 支出	query	false
其他参数	押金记录	query	false	Deposit	Deposit
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	用户ID		false	integer(int64)
refCode	业务编号		false	string
number	订单号		false	string
amount	金额		false	number
status	-1 待支付 0申请退回待处理 1在押 2已退		false	integer(int32)
dateAdd	添加时间		false	string(date-time)
dateAutoBack	自动退还时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)
dateBack	退还时间		false	string(date-time)
remark	备注		false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

收押金

接口地址:/apifmUser/deposit/pay

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
uid	用户编号	query	true	integer(int32)
mobile	手机号码	query	true	string
amount	押金金额	query	true	number
refCode	业务编号	query	true	string
remark	备注	query	true	string
dateAutoBack	自动退押金时间，yyyy-MM-dd HH:mm:ss 格式，不传该参数为不自动退押金	query	true	string
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

押金列表

接口地址:/apifmUser/deposit/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
dateAutoBackBegin	更新时间起,格式 2018-05-16	query	true	string
dateAutoBackEnd	更新时间起,格式 2018-05-16	query	true	string
dateUpdateBegin	更新时间起,格式 2018-05-16	query	true	string
dateUpdateEnd	更新时间起,格式 2018-05-16	query	true	string
dateBackBegin	更新时间起,格式 2018-05-16	query	true	string
dateBackEnd	更新时间起,格式 2018-05-16	query	true	string
mobileUser	用户手机号码	query	true	string
nick	用户昵称	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	押金记录	query	false	Deposit	Deposit
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	用户ID		false	integer(int64)
refCode	业务编号		false	string
number	订单号		false	string
amount	金额		false	number
status	-1 待支付 0申请退回待处理 1在押 2已退		false	integer(int32)
dateAdd	添加时间		false	string(date-time)
dateAutoBack	自动退还时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)
dateBack	退还时间		false	string(date-time)
remark	备注		false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

退押金

接口地址:/apifmUser/deposit/back

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

充值统计

接口地址:/apifmUser/apiExtUserPay/statistics

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
shopId	门店ID, 传0读取无门店充值记录	query	true	integer(int32)
payGate	支付方式	query	true	string
day	指定日期,格式 2020-10-10, 传 all 读取全局统计	query	true	string
dayBegin	统计日期起,格式 2020-10-10	query	true	string
dayEnd	统计日期止,格式 2020-11-10	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取提现设置信息

接口地址:/apifmUser/withdrawalSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户提现详情

接口地址:/apifmUser/withdrawalLog/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

押金详情

接口地址:/apifmUser/deposit/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

投票模块

投票明细记录列表

接口地址:/apifmUser/voteJoin/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	报名时间起,格式 2018-05-16	query	true	string
dateAddEnd	报名时间止,格式 2018-05-16	query	true	string
mobile	用户手机号码	query	true	string
nick	用户昵称	query	true	string
categoryId	项目分类	query	true	integer(int32)
X-Token	管理员登录凭证	header	true
id	投票ID	query	false
voteId	投票项目ID	query	false
uid	投票用户ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改投票项目

接口地址:/apifmUser/voteInfo/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
dateBeginStr	开始时间,格式：yyyy-MM-dd HH:mm:ss	query	true	string
dateEndStr	截止时间,格式：yyyy-MM-dd HH:mm:ss	query	true	string
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
id	添加不传；修改传需要修改的记录id	query	false
title	标题	query	false
mp3	音频地址	query	false
mp4	视频地址	query	false
type	类型：0 手动添加 1 报名系统导入	query	false
refId	type对应的外键ID	query	false
rule	0 单选 1 多选	query	false
isPublic	投票信息是否公开（是否匿名） true / false	query	false
content	详细说明	query	false
status	状态：0开启；1关闭	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

投票项目列表

接口地址:/apifmUser/voteInfo/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateBeginBegin	开始时间起,格式 2018-05-16	query	true	string
dateBeginEnd	开始时间止,格式 2018-05-16	query	true	string
dateEndBegin	截止时间起,格式 2018-05-16	query	true	string
dateEndEnd	截止时间止,格式 2018-05-16	query	true	string
titleLike	项目名称模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
id	编号	query	false
type	类型：0 手动添加 1 报名系统导入	query	false
refId	type对应的外键ID	query	false
rule	0 单选 1 多选	query	false
isPublic	投票信息是否公开（是否匿名） true / false	query	false
status	状态：'0 开启 1 关闭	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改投票项目的投票选项

接口地址:/apifmUser/voteInfo/items/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
voteId	投票项目ID	query	true
id	添加不传；修改传需要修改的记录id	query	false
title	投票选项名称	query	false
descript	投票选项描述	query	false
status	状态：0开启；1关闭	query	false
paixu	排序，数字越小越靠前	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除投票项目的选项

接口地址:/apifmUser/voteInfo/items/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

投票项目设为-取消优选项

接口地址:/apifmUser/voteInfo/items/best

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

从报名模块导入投票数据

接口地址:/apifmUser/voteInfo/importFromYuyue

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
yuyueId	报名项目ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除投票项目

接口地址:/apifmUser/voteInfo/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	编号，多个编号用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

投票项目详情

接口地址:/apifmUser/voteInfo/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

AI

AI生成图片

接口地址:/apifmUser/volcesArk/createImage

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
prompt	提示词（prompt）建议：【艺术风格】+【主体描述】+【文字排版】	query	true	string
width	图片宽度，取值范围：[256, 768]	query	true	integer(int32)
height	图片高度，取值范围：[256, 768]	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

AI协作

接口地址:/apifmUser/volcesArk/createChatCompletion

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
message	需要让AI帮你做什么，尽量把你的需求描述清楚	query	true	string
type	1 写文章； 2 写公告	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

流媒体

vod视频点播设置

接口地址:/apifmUser/vodSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
type	aliyun / tencent	query	true
accessKeyId	AccessKey ID 和 AccessKey Secret 是您访问阿里云 API 的密钥	query	true
secret	AccessKey ID 和 AccessKey Secret 是您访问阿里云 API 的密钥	query	true
regionId	地域代码，阿里云点播的话必填，https://help.aliyun.com/document_detail/98194.htm	query	false
procedure	腾讯云视频后续处理操作任务流模板名	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除vod视频点播设置

接口地址:/apifmUser/vodSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	aliyun / tencent	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

腾讯云上传成功后添加视频信息

接口地址:/apifmUser/vodBase/tcVodAddFile

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
url	视频地址	query	true	string
X-Token	管理员登录凭证	header	true
title	标题	query	true
videoId	视频ID	query	true
size	视频文件大小(字节)	query	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

视频点播列表

接口地址:/apifmUser/vodBase/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间起,格式 2018-05-16	query	true	string
dateUploadBegin	更新时间起,格式 2018-05-16	query	true	string
dateUploadEnd	更新时间起,格式 2018-05-16	query	true	string
titleLike	标题	query	true	string
X-Token	管理员登录凭证	header	true
videoId	视频编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除视频点播

接口地址:/apifmUser/vodBase/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	删除记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改视频点播封面图片

接口地址:/apifmUser/vodBase/changeCover

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	修改记录ID（数字类型，并非是视频编号）	query	true	integer(int64)
coverUrl	分明图片URL	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取阿里云视频点播上传凭证

接口地址:/apifmUser/vodBase/authAndAddress

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

上传视频之前需要获取凭证，有了凭证才能上传视频

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
fileName	上传的视频文件名称，视频源文件名称（必须带后缀, 支持 ".3gp", ".asf", ".avi", ".dat", ".dv", ".flv", ".f4v", ".gif", ".m2t", ".m3u8", ".m4v", ".mj2", ".mjpeg", ".mkv", ".mov", ".mp4", ".mpe", ".mpg", ".mpeg", ".mts", ".ogg", ".qt", ".rm", ".rmvb", ".swf", ".ts", ".vob", ".wmv", ".webm"".aac", ".ac3", ".acm", ".amr", ".ape", ".caf", ".flac", ".m4a", ".mp3", ".ra", ".wav", ".wma"）	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取vod视频点播设置

接口地址:/apifmUser/vodSet/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取vod视频点播设置详情

接口地址:/apifmUser/vodSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
type	aliyun / tencent	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取腾讯云视频点播上传凭证

接口地址:/apifmUser/vodBase/tcVodSignature

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

上传视频之前需要获取凭证，有了凭证才能上传视频

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
procedure	视频后续处理操作任务流模板名	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商城模块

知识设置添加-修改

接口地址:/apifmUser/virtualTraderSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
detailsJsonStr	付费的属性JSON格式	query	true	string
X-Token	管理员登录凭证	header	true
categoryId	所属分类ID	query	true
price	价格	query	true
id	添加不传；修改传需要修改的记录id	query	false
name	名称	query	false
buyNumber	已售数量	query	false
status	状态：'0 上架 1 下架	query	false
content	内容详情	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

知识商品设置

接口地址:/apifmUser/virtualTraderSet/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间止,格式 2018-05-16	query	true	string
nameLike	名称	query	true	string
categoryIdSel	所属类别ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true
id	编号	query	false
status	状态：'0 上架 1 下架	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除知识

接口地址:/apifmUser/virtualTraderSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	知识ID，批量删除请用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

知识交易购买记录

接口地址:/apifmUser/virtualTraderBuyLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	交易时间起,格式 2018-05-16	query	true	string
dateAddEnd	交易时间止,格式 2018-05-16	query	true	string
mobile	手机号码	query	true	string
nick	昵称	query	true	string
X-Token	管理员登录凭证	header	true
vId	知识编号	query	false
uid	用户编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除知识交易记录

接口地址:/apifmUser/virtualTraderBuyLog/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	购买记录ID，批量删除请用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

技师解绑商家

接口地址:/apifmUser/userAttendant/unbindShop

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	技师ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改技师信息

接口地址:/apifmUser/userAttendant/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
idCardNo	身份证号码，添加的时候必填，编辑的时候忽略	query	true	string
serviceShopIds	技师可服务的门店ID，多个门店之间用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true
id	技师ID	query	true
jobNumber	工号	query	false
name	技师姓名	query	false
zc	职称	query	false
mobile	手机号码	query	false
gender	性别，0 未知 1 男性 2 女性	query	false
age	年龄	query	false
shopId	门店ID	query	false
picLive	实拍照片	query	false
picShow	工装照照片	query	false
picIdcard1	身份证正面照片	query	false
picIdcard2	身份证反面照片	query	false
picJkz	健康证照片	query	false
picCyzg	从业执照照片	query	false
picOther	其他资质照片	query	false
similarRate	工装照片和实拍照片相似度	query	false
tags	技能标签	query	false
content	个人介绍	query	false
status	工作状态 0 上班；1 休息	query	false
vetStatus	审核状态 0 待审核 1 通过 2不通过	query	false
provinceId	所在省份ID	query	false
cityId	所在城市ID	query	false
districtId	所在区县ID	query	false
streetId	所在街道ID	query	false
constellation	星座	query	false
alipayName	支付宝真实姓名	query	false
alipayAccount	支付宝账号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

技师列表

接口地址:/apifmUser/userAttendant/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	技师姓名模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
shopId	商家ID	query	false
status	工作状态：0 上班；1 休息	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除技师

接口地址:/apifmUser/userAttendant/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	技师ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改技师工作状态

接口地址:/apifmUser/userAttendant/changeStatus

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	技师ID	query	true	integer(int64)
status	0 上班；1 休息	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

批量修改技师推荐状态

接口地址:/apifmUser/userAttendant/changeRecommendStatus

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	技师ID，多个用英文逗号分割	query	true	array	integer
recommendStatus	0 一般 1 推荐	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店员工设置

接口地址:/apifmUser/shopStaff/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录ID,修改的时候需要传	query	false
shopId	门店ID	query	false
name	姓名	query	false
mobile	手机号码	query	false
pwd	密码，不修改原密码，无需传该参数	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店员工列表

接口地址:/apifmUser/shopStaff/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	姓名模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
shopId	门店ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除门店员工

接口地址:/apifmUser/shopStaff/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	工号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店探头列表

接口地址:/apifmUser/shopCamera/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	探头名称模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
shopId	门店ID	query	false
taiNum	台号	query	false
deviceSn	探头序列号	query	false
status	状态 0 正常； 1 离线	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

取货点设置

接口地址:/apifmUser/pickPoint/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号,修改的时候需要传	query	true
shopId	门店ID	query	false
type	类型	query	false
name	名称	query	false
address	地址	query	false
tel	联系方式	query	false
latitude	地图坐标纬度	query	false
longitude	地图坐标经度	query	false
paixu	排序	query	false
status	0 正常； 1 禁用	query	false
numberOrderMax	最多订单数	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

取货点列表

接口地址:/apifmUser/pickPoint/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
shopId	门店ID	query	false
type	类型	query	false
status	0 正常； 1 停用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除取货点

接口地址:/apifmUser/pickPoint/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	取货点ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品关联知识付费列表

接口地址:/apifmUser/goodsVirtualTrader/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
showVirtualTraderMap	是否显示知识付费项目信息	query	true	boolean
X-Token	管理员登录凭证	header	true
goodsId	商品id	query	false
virtualTraderId	知识付费项目ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除关联知识付费商品

接口地址:/apifmUser/goodsVirtualTrader/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	记录编号，多个编号用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

关联知识付费商品

接口地址:/apifmUser/goodsVirtualTrader/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsId	商品id	query	true	integer(int64)
virtualTraderIds	知识付费项目ID，多个编号用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品库存变化明细列表

接口地址:/apifmUser/goodsStoresLogs/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
goodsId	商品ID	query	false
propertyChildIds	规格尺寸信息	query	false
type	变更类型	query	false
behavior	0 增加 1 减少	query	false
其他参数	商品库存变化明细	query	false	GoodsStoresLogs	GoodsStoresLogs
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
goodsId	商品ID		false	integer(int64)
propertyChildIds	规格尺寸ids		false	string
propertyChildNames	规格尺寸名称		false	string
type	变更类型		false	string
behavior	0 增加 1 减少		false	integer(int32)
stores	变更数量		false	integer(int32)
storesLeft	剩余库存数		false	integer(int32)
dateAdd	操作时间		false	string(date-time)
remark	备注		false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设置商品购买返利

接口地址:/apifmUser/goodsBuyReward/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
goodsId	商品id	query	true	integer(int64)
triggerStatus	1 支付即返 3 交易成功返 4 评价后返	query	true	integer(int32)
commission	奖励数值	query	true	number
type	奖励类型 1 积分 2 现金 3 赠送优惠券	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

购买返利设置列表

接口地址:/apifmUser/goodsBuyReward/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	商品名称	query	true	string
X-Token	管理员登录凭证	header	true
goodsId	商品ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除购买返利

接口地址:/apifmUser/goodsBuyReward/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	记录id, 多条记录使用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商城活动添加-编辑

接口地址:/apifmUser/activityMallInfo/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数	商城活动	query	false	ActivityMallInfo	ActivityMallInfo
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
title	活动名称		false	string
titleSub	副标题		false	string
bannerType	轮播图对应类型		false	string
disclaimerPageKey	免责声明对应单页key		false	string
couponRuleIds	活动配置优惠券规则ID，英文逗号分隔		false	string
goodsIds	活动配置商品ID，英文逗号分隔		false	string
dateStart	活动开始时间		false	string(date-time)
dateDeadline	活动截止时间		false	string(date-time)
address	活动地址		false	string
status	0 上架 1 下架		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商城活动列表

接口地址:/apifmUser/activityMallInfo/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
titleLike	标题关键词搜索	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除商城活动

接口地址:/apifmUser/activityMallInfo/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	活动ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取知识详情

接口地址:/apifmUser/virtualTraderSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	知识ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

技师详情

接口地址:/apifmUser/userAttendant/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	技师ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店-商家每日数据统计

接口地址:/apifmUser/shopStatisticsDay/day

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
shopId	门店ID	query	true	integer(int32)
day	日期，格式如：20220611	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店员工详情

接口地址:/apifmUser/shopStaff/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	工号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店探头详情

接口地址:/apifmUser/shopCamera/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

取货点详情

接口地址:/apifmUser/pickPoint/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	取货点ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商城活动详情

接口地址:/apifmUser/activityMallInfo/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	活动ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户管理

用户福利记录列表

接口地址:/apifmUser/userWelfare/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	姓名	query	true	string
X-Token	管理员登录凭证	header	true
uid	用户编号	query	false
levelId	会员等级编号	query	false
mobile	手机号码	query	false
status	0 未领取 1 已领取	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除用户福利记录

接口地址:/apifmUser/userWelfare/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

批量发放用户福利

接口地址:/apifmUser/userWelfare/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
content	批量导入的数据，是json的数组，例如：[{level:'黄金会员',mobile:'13500000000',nick:'张三',money:0}]	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改用户标签

接口地址:/apifmUser/userTag/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录ID，修改的时候传，添加不需要传	query	true
name	名称	query	false
certificateScore	用户通过该标签认证赠送多少积分	query	false
paixu	排序，数字越小越靠前	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户标签列表

接口地址:/apifmUser/userTag/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除用户标签

接口地址:/apifmUser/userTag/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	标签ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改收货地址

接口地址:/apifmUser/userShippingAddress/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
isDefault	是否默认收货地址 true/false	query	false
provinceId	省份编码	query	false
cityId	城市编码	query	false
districtId	区县编码	query	false
address	详细地址	query	false
code	邮编	query	false
linkMan	收件人	query	false
mobile	收件人手机	query	false
idcard	身份证号码	query	false
status	状态 0-正常，1-禁用	query	false
latitude	地图纬度	query	false
longitude	地图经度	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户收货地址列表

接口地址:/apifmUser/userShippingAddress/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间起,格式 2018-05-16	query	true	string
dateUpdateBegin	修改时间起,格式 2018-05-16	query	true	string
dateUpdateEnd	修改时间起,格式 2018-05-16	query	true	string
mobileUser	注册用户手机号码	query	true	string
nick	注册用户昵称	query	true	string
X-Token	管理员登录凭证	header	true
uid	用户编号	query	false
isDefault	是否默认收货地址 true/false	query	false
mobile	收件人手机	query	false
status	状态 0-正常，1-禁用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除用户收货地址

接口地址:/apifmUser/userShippingAddress/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改会员等级

接口地址:/apifmUser/userLevel/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
name	等级名称	query	false
paixu	排序	query	false
rebate	折扣	query	false
upgradeAmount	消费满多少金额自动升级到该会员	query	false
upgradeRechargeAmount	累计充值满多少金额自动升级到该会员	query	false
upgradeRechargeAmountSingle	单笔充值满多少金额自动升级到该会员	query	false
status	状态 0-正常，1-禁用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改会员等级收费项目

接口地址:/apifmUser/userLevel/save/price

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
levelId	会员等级ID	query	false
duration	会员时长	query	false
unit	单位 0 天 1 月 2 年	query	false
price	价格	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

会员等级列表

接口地址:/apifmUser/userLevel/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
id	等级编号	query	false
status	状态 0-正常，1-禁用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除会员等级

接口地址:/apifmUser/userLevel/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	会员等级id，多条记录编号用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除会员等级的某个收费项目

接口地址:/apifmUser/userLevel/del/price

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	收费项目ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除用户好友关系

接口地址:/apifmUser/userFriend/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

uidm 和 uids 至少传一个，都传的话为 AND 条件而不是 OR 的关系

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
uidm	清空该用户的所有好友	query	true	integer(int64)
uids	把当前用户从所有人的好友列表中删除	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改部门信息

接口地址:/apifmUser/userDepartment/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
id	部门ID	query	true
name	部门名称	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

部门列表

接口地址:/apifmUser/userDepartment/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除部门

接口地址:/apifmUser/userDepartment/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	部门ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

批量检索用户

接口地址:/apifmUser/userBase/search

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

批量检测一批用户是否已注册，并返回用户编号，手机号，昵称等信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
field	检索字段 nick mobile	query	true	string
val	需要检索的字符串数组，用英文逗号分隔	query	true	array	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改用户信息

接口地址:/apifmUser/userBase/modify

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户编号	query	true	integer(int64)
openid	用户对应微信的openid	query	true	string
unionid	用户对应微信的unionid	query	true	string
mobile	手机号码, unbind 为解除手机号码绑定	query	true	string
nick	昵称	query	true	string
pwd	新密码，不传该参数代表不修改密码	query	true	string
levelId	会员等级, 传 0 为取消用户等级	query	true	integer(int32)
levelExpireStr	会员到期时间，格式为: 2023-04-05 11:19:50	query	true	string
isSeller	是否设置为分销商, trrue / false	query	true	boolean
sellerLevelId	分销商等级ID	query	true	integer(int32)
avatarUrl	头像图片路径	query	true	string
nfcCardId	nfc卡序列号, unbind 为解除绑定	query	true	string
username	用户名, unbind 为解除手机号码绑定	query	true	string
email	电子邮箱地址, unbind 为解除手机号码绑定	query	true	string
status	0 为正常，1 为禁用	query	true	integer(int32)
wx	微信号	query	true	string
departmentId	所属部门ID	query	true	integer(int32)
remark	备注	query	true	string
extJsonStr	扩展属性的JSON格式数据	query	true	string
tags	用户标签，多个标签用英文逗号分割	query	true	string
type	自定义用户类型	query	true	integer(int32)
grade	年级（适合做校园类小程序）	query	true	string
shopId	所属门店	query	true	integer(int32)
xiaoqu	所在校区	query	true	string
cover	封面图	query	true	string
serviceCities	可服务的城市ID，多个用英文逗号分隔	query	true	string
province	省份	query	true	string
city	城市	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户列表

接口地址:/apifmUser/userBase/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页显示多少数据	query	true	integer(int64)
dateAddBegin	注册时间起,格式 2018-05-16	query	true	string
dateAddEnd	注册时间止,格式 2018-05-16	query	true	string
dateLoginBegin	最后登录时间起,格式 2018-05-16	query	true	string
dateLoginEnd	最后登录时间止,格式 2018-05-16	query	true	string
nfcCardId	nfc卡序列号	query	true	string
ids	多个用户编号用英文逗号分隔开	query	true	array	integer
wxOpenid	微信的openid搜索	query	true	string
getLevelDateBegin	成为会员时间起,格式 2018-05-16	query	true	string
getLevelDateEnd	成为会员时间止,格式 2018-05-16	query	true	string
idCardNo	身份证号码	query	true	string
extendKeywords	扩展属性搜索关键词	query	true	string
nickLike	昵称	query	true	string
showExtJson	显示扩展属性	query	true	boolean
showSallerLevel	是否返回分销商等级信息	query	true	boolean
X-Token	管理员登录凭证	header	true
id	用户编号	query	false
referrer	邀请人用户编号	query	false
source	注册来源：0 小程序 1 手机注册 2 公众号 3 支付宝小程序	query	false
mobile	手机号码	query	false
username	用户名	query	false
province	省份	query	false
city	城市	query	false
ipAdd	注册IP	query	false
ipLogin	登录IP	query	false
status	状态	query	false
isSeller	是否是分销商,传 true/false	query	false
isIdcardCheck	是否实名认证,传 true/false	query	false
levelId	会员等级id,0 为所有无分组用户	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除用户

接口地址:/apifmUser/userBase/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	用户编号,批量删除请用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

团队长列表

接口地址:/apifmUser/teamLeader/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页显示多少数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
id	用户编号	query	false
partnerId	合伙人编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除团队长

接口地址:/apifmUser/teamLeader/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	用户编号,多个用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取用户标签详情

接口地址:/apifmUser/userTag/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	标签ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户收货地址详情

接口地址:/apifmUser/userShippingAddress/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取会员等级的收费列表

接口地址:/apifmUser/userLevel/prices

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	会员等级ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取会员等级详情

接口地址:/apifmUser/userLevel/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	等级ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取部门详情

接口地址:/apifmUser/userDepartment/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	部门ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取用户登录token，用于三方系统登录后获得用户登录的token

接口地址:/apifmUser/userBase/token

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	用户编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取用户详情

接口地址:/apifmUser/userBase/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	用户编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取用户详情(根据nfc卡的序列号)

接口地址:/apifmUser/userBase/info/nfc

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
cardId	nfc卡的序列号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取用户详情(根据手机号码)

接口地址:/apifmUser/userBase/info/mobile

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
mobile	手机号码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取用户详情(根据动态会员码)

接口地址:/apifmUser/userBase/info/dynamicUserCode

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

有效期为1分钟，使用一次以后即刻失效

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	动态会员码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

财务模块

资金明细

接口地址:/apifmUser/userCashLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
mobile	用户手机号码	query	true	string
nick	用户昵称	query	true	string
baseZero	equals 交易金额为0； gt 交易金额大于0； lt 交易金额小于0	query	true	string
aggregate	是否返回统计数据	query	true	boolean
X-Token	管理员登录凭证	header	true
其他参数	资金明细	query	false	UserCashLog	UserCashLog
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
shopId	门店ID		false	integer(int32)
uid	用户ID		false	integer(int64)
behavior	0 收入 1 支出		false	integer(int32)
type	0 充值 11 提现申请 12 提现失败 1 提现成功 2 支付订单 3 退款 4支付预约报名费 5 知识付费 6分销返佣 7 分享商品奖励 8 买单 9 充值赠送		false	integer(int32)
amount	金额		false	number
balance	剩余可用		false	number
freeze	剩余冻结		false	number
orderId	直接操作的业务订单ID		false	integer(int64)
orderId2	有关系的编号2，比如订单id，拉取相关所有明细		false	integer(int64)
orderIdExtSystem	外部系统订单号		false	integer(int64)
remark	备注		false	string
dateAdd	添加时间		false	string(date-time)
amountZero	-1 金额负数 0 金额为0 1 金额正数		false	integer(int32)
typeStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

字节小程序

修改头条小程序配置

接口地址:/apifmUser/ttSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
appid	appid	query	true
secret	secret	query	false
payAppId	支付appID，在抖音开放平台后台，支付界面申请开通后获取	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取头条小程序二维码

接口地址:/apifmUser/ttSet/qrcode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
content	二维码参数，json形式，无需传 access_token, https://microapp.bytedance.com/dev/cn/mini-app/develop/server/qr-code/createqrcode	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除头条小程序配置

接口地址:/apifmUser/ttSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取当前头条小程序配置

接口地址:/apifmUser/ttSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

积分模块

做任务送积分设置

接口地址:/apifmUser/taskSetting/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
type	任务类型，对应的具体业务逻辑	query	false
group	分组名称	query	false
name	任务名称	query	false
remark	任务备注	query	false
paixu	排序，数字越小越靠前	query	false
isDaily	是否为每日任务	query	false
score	完成任务可获得多少积分	query	false
maxTimes	（每天）最多可做几次任务	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除做任务送积分设置

接口地址:/apifmUser/taskSetting/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改积分抵扣规则

接口地址:/apifmUser/scoreDeductionRule/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsIds	下单抵扣规则添加时有效，传可用的商品编号，多个用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
goodsId	针对某个商品特殊设置，预留字段，暂时没有启用	query	false
score	积分数	query	false
money	抵扣金额	query	false
loop	true/false ,假如充100抵10元，是否自动200积分可以抵20元	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

积分抵扣规则列表

接口地址:/apifmUser/scoreDeductionRule/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除积分抵扣规则设置

接口地址:/apifmUser/scoreDeductionRule/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

做任务送积分设置列表

接口地址:/apifmUser/taskSetting/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

积分抵扣规则详情

接口地址:/apifmUser/scoreDeductionRule/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

数据统计

拉取分销商佣金及销售统计记录

接口地址:/apifmUser/statisticsCommision/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dayBegin	统计日期起,格式 20180516	query	true	string
dayEnd	统计日期止,格式 20190516	query	true	string
X-Token	管理员登录凭证	header	true
uid	用户编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

小程序每日访问分析[包含支付人数]

接口地址:/apifmUser/statistics/wxaDailyVisit

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dayBegin	统计日期起,格式 2018-05-16	query	true	string
dayEnd	统计日期止,格式 2018-05-16	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取每天增量数据

接口地址:/apifmUser/statistics/days

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
quickDays	拉取最近几天的数据	query	true	integer(int32)
dateStart	开始日期，格式 2020-05-07	query	true	string
dateEnd	截止日期，格式 2020-05-07	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

IoT设备

修改设备信息

接口地址:/apifmUser/shopIot/update

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
topic	设备编号	query	true
shopId	门店ID	query	false
name	设备名称	query	false
status	0 正常； 1 禁用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改指令信息

接口地址:/apifmUser/shopIot/updateCMD

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	指令ID	query	true	integer(int64)
name	指令名称	query	true	string
userControl	针对用户可见或者隐藏	query	true	boolean
goodsId	绑定商品ID	query	true	integer(int64)
paixu	排序	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设备列表

接口地址:/apifmUser/shopIot/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	设备名称模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
status	0 正常； 1 禁用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

发送设备指令

接口地址:/apifmUser/shopIot/execute

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	指令ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设备在线状态

接口地址:/apifmUser/shopIot/online

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
topic	设备编号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设备详情

接口地址:/apifmUser/shopIot/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
topic	设备编号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取设备指令集

接口地址:/apifmUser/shopIot/cmds

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
topic	设备编号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

门店财务模块

调整门店余额

接口地址:/apifmUser/shopCash/modifyBalance

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	门店ID(门店ID和门店编号至少传一项)	query	true	integer(int32)
number	门店编号(门店ID和门店编号至少传一项)	query	true	string
money	调整金额，负数代表扣除余额	query	true	number
remark	备注	query	true	string
payGateExt	扩展支付类型	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分销管理

添加-修改分销团队

接口地址:/apifmUser/saleDistributionTeam/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
leader	队长用户编号	query	true
deputyLeader	副队长用户编号	query	false
name	团队名称	query	false
standardSaleroom	考核月度达标销售额	query	false
p1	队长返佣比例	query	false
p2	副队长返佣比例	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分销团队列表

接口地址:/apifmUser/saleDistributionTeam/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
id	等级编号	query	false
其他参数	团队管理	query	false	SaleDistributionTeam	SaleDistributionTeam
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
name	名称，默认为 xxx的团队		false	string
leader	队长用户ID		false	integer(int64)
deputyLeader	副队长用户ID		false	integer(int64)
days	考核周期n天		false	integer(int32)
standardSaleroom	达标月度销售额		false	number
curSaleroom	当前销售额		false	number
tkAmount	当前退款累计金额		false	number
dateAdd	添加时间		false	string(date-time)
p1	队长返佣比例，%		false	number
p2	副队长返佣比例，%		false	number
reportMonth	上次考核日期		false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除分销团队

接口地址:/apifmUser/saleDistributionTeam/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分销设置

接口地址:/apifmUser/saleDistributionSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
isOpen	开启/关闭返佣功能	query	true
type	0 现金返佣；1积分返佣	query	true
earningsPercent	商品返佣比例，单位为%	query	true
triggerType	0 支付即返；1 交易成功返	query	true
widthdrawType	0 人工提现；1 微信打款	query	true
p1	1级返佣比例，%	query	true
p2	2级返佣比例，%	query	true
p3	3级返佣比例，%	query	true
applyAutoPass	分销商申请是否自动审核通过	query	true
userLevelBuyOpen	购买会员是否开启返佣	query	true
scoreSignOpen	签到送积分开启返佣	query	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设置商品分销比例

接口地址:/apifmUser/saleDistributionLevelGoodsP/set

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
goodsIds	商品id，多个商品用英文逗号隔开	query	true	array	integer
levelId	分销等级id	query	true	integer(int32)
p1	1级返佣比例，%	query	true	number
p2	2级返佣比例，%	query	true	number
p3	3级返佣比例，%	query	true	number
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品分销比例列表

接口地址:/apifmUser/saleDistributionLevelGoodsP/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
levelId	等级ID	query	false
goodsId	商品ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除商品分销比例

接口地址:/apifmUser/saleDistributionLevelGoodsP/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	记录id, 多个商品使用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改分销等级

接口地址:/apifmUser/saleDistributionLevel/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
p1	1级返佣比例，%	query	true
p2	2级返佣比例，%	query	true
p3	3级返佣比例，%	query	true
name	等级名称	query	false
level	级别，数字越大，级别越高	query	false
upgradeOrderNumber	推广订单数达到多少可升级至该等级	query	false
upgradeAmount	销售额达到多少可升级至该等级	query	false
upgradeCommision	推广佣金达到多少可升级至该等级	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分销等级列表

接口地址:/apifmUser/saleDistributionLevel/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
id	等级编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除分销等级

接口地址:/apifmUser/saleDistributionLevel/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	等级ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改分组

接口地址:/apifmUser/saleDistributionGroup/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
name	名称	query	true
id	添加不传；修改传需要修改的记录id	query	false
remark	备注	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除分组

接口地址:/apifmUser/saleDistributionGroup/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加-修改分销区域合伙人

接口地址:/apifmUser/saleDistributionCity/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	记录编号	query	true
provinceId	省份ID	query	true
cityId	城市ID	query	true
uid	用户编号	query	true
standardSaleroom	考核月度达标销售额	query	false
p	返佣比例	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分销区域合伙人列表

接口地址:/apifmUser/saleDistributionCity/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	押金记录	query	false	Deposit	Deposit
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	用户ID		false	integer(int64)
refCode	业务编号		false	string
number	订单号		false	string
amount	金额		false	number
status	-1 待支付 0申请退回待处理 1在押 2已退		false	integer(int32)
dateAdd	添加时间		false	string(date-time)
dateAutoBack	自动退还时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)
dateBack	退还时间		false	string(date-time)
remark	备注		false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除分销区域合伙人

接口地址:/apifmUser/saleDistributionCity/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查看团队销售报表

接口地址:/apifmUser/saleDistributionTeam/report

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
teamId	团队id	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取分销团队详情

接口地址:/apifmUser/saleDistributionTeam/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取当前分销设置

接口地址:/apifmUser/saleDistributionSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取分销等级详情

接口地址:/apifmUser/saleDistributionLevel/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	等级ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分组列表

接口地址:/apifmUser/saleDistributionGroup/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

分组详情

接口地址:/apifmUser/saleDistributionGroup/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	分组id	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查看区域合伙人销售报表

接口地址:/apifmUser/saleDistributionCity/report

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
cityId	城市ID	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取分销区域合伙人详情

接口地址:/apifmUser/saleDistributionCity/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

站点设置

重置商户秘钥

接口地址:/apifmUser/resetKey

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mock接口添加-编辑

接口地址:/apifmUser/mockApi/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
groupId	分组ID	query	true
name	名称	query	true
url	路径地址	query	true
method	请求方式 get/post/put/delete	query	true
content	接口模拟返回的内容	query	true
id	添加不传；修改传需要修改的记录id	query	false
describe	描述	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mock分组添加-编辑

接口地址:/apifmUser/mockApi/save-group

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
name	名称	query	true
url	路径	query	true
id	添加不传；修改传需要修改的记录id	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除mock接口

接口地址:/apifmUser/mockApi/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	接口ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除mock接口分组

接口地址:/apifmUser/mockApi/del-group

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	分组ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

将某登录管理员踢下线

接口地址:/apifmUser/kickOut

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
xtoken	要踢掉的登录的xtoken	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改手机号码

接口地址:/apifmUser/editMobile/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
mobile	新的手机号码	query	true	string
oldPwd	当前账号登录密码	query	true	string
smsCode	短信验证码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改真实姓名

接口地址:/apifmUser/changeName

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
realName	真实姓名	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改专属域名

接口地址:/apifmUser/changeDomain

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
domain	专属域名，只能是数字和大小写字母的组合	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

充值

接口地址:/apifmUser/centerUserCashLog/recharge

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

是后台的充值，并非是用户的充值，千万不要混淆

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
money	充值金额	query	true	number
payType	alipay wx	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

账务明细

接口地址:/apifmUser/centerUserCashLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

是工厂的账务明细，并非是用户的账务明细，千万不要混淆

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
remarkLike	备注关键词搜索	query	true	string
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
X-Token	管理员登录凭证	header	true
behavior	0 收入； 1 支出	query	false
type	交易类型 0 充值 1 返佣 2 提现 3 购买插件 4 管理员调整	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改邮箱地址

接口地址:/apifmUser/bindMail

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
email	邮箱地址	query	true	string
oldPwd	当前账号登录密码	query	true	string
mailCode	邮件验证码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

Banner设置

接口地址:/apifmUser/bannerInfo/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
type	类型，自定义类型	query	true
businessId	业务编号	query	true
title	标题名称	query	true
picUrl	图片URL地址	query	true
paixu	排序	query	true
id	添加不传；修改传需要修改的记录id	query	false
shopAreaId	门店区域ID	query	false
shopId	门店ID	query	false
picUrl2	图片URL地址2【用于扩展】	query	false
linkType	链接类型，0 普通链接； 1 跳转小程序	query	false
appid	如果是跳转小程序，这里填目标小程序的appID	query	false
linkUrl	链接地址	query	false
status	状态，0 显示 1 隐藏	query	false
remark	备注说明	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

Banner列表

接口地址:/apifmUser/bannerInfo/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
shopAreaId	门店区域ID	query	false
shopId	门店ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除Banner

接口地址:/apifmUser/bannerInfo/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID，多个ID用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

当前登录账号信息

接口地址:/apifmUser/auth

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
uri	需要检测的请求地址权限	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

广告位添加-修改

接口地址:/apifmUser/adPosition/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
key	编号	query	true
id	添加不传；修改传需要修改的记录id	query	false
type	自定义类型 pic,txt,video	query	false
val	广告位内容	query	false
url	链接地址	query	false
status	0 正常； 1 停用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

广告位列表

接口地址:/apifmUser/adPosition/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
status	0 正常； 1 停用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除广告位

接口地址:/apifmUser/adPosition/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录id,多个id用英文的逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

统计当前站点数据

接口地址:/apifmUser/statistics

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

拉取当前用户的权限列表

接口地址:/apifmUser/myActions

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mock接口列表

接口地址:/apifmUser/mockApi/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mock接口详情

接口地址:/apifmUser/mockApi/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	接口ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查看当前已登录的管理员列表

接口地址:/apifmUser/logedAdminList

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int32)
pageSize	每页获取几条数据	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

当前登录账号信息

接口地址:/apifmUser/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

token有效性校验

接口地址:/apifmUser/checkToken

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

状态码0表示有效；100000表示token无效；100001表示token过期

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
uri	需要检测的请求地址权限	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取所有的Banner类型

接口地址:/apifmUser/bannerInfo/types

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

Banner详情

接口地址:/apifmUser/bannerInfo/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

广告位详情

接口地址:/apifmUser/adPosition/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	广告位记录ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

QQ小程序

修改QQ小程序配置

接口地址:/apifmUser/qqSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
appid	appid	query	true
secret	secret	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取QQ小程序二维码(正方形的)

接口地址:/apifmUser/qqSet/qrcode

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
content	页面路径，如: pages/index/index	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除当前QQ小程序配置

接口地址:/apifmUser/qqSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取QQ小程序当前配置

接口地址:/apifmUser/qqSet/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

营销辅助

拼团设置添加-修改

接口地址:/apifmUser/pingtuanSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
dateEndStr	截止时间,格式 2018-05-16 12:23:34	query	true	string
X-Token	管理员登录凭证	header	true
goodsId	商品ID	query	true
numberSucccess	已成团数量	query	true
numberPersion	需要几人才能成团	query	true
timeoutHours	超时时间，单位为小时，超时未成团，自动退款	query	true
status	状态：0 正常 1 禁用	query	true
refundType	退款方式：0 退到工厂用户余额 1 原路退回	query	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

拼团设置列表

接口地址:/apifmUser/pingtuanSet/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	开始时间起,格式 2018-05-16	query	true	string
dateAddEnd	开始时间止,格式 2018-05-16	query	true	string
dateEndBegin	截止时间起,格式 2018-05-16	query	true	string
dateEndEnd	截止时间止,格式 2018-05-16	query	true	string
X-Token	管理员登录凭证	header	true
id	拼团ID	query	false
goodsId	商品ID	query	false
status	状态：0 正常 1 禁用	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除拼团设置

接口地址:/apifmUser/pingtuanSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	拼团设置ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

拼团记录

接口地址:/apifmUser/pingtuanHelp/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	购买时间起,格式 2018-05-16	query	true	string
dateAddEnd	购买时间止,格式 2018-05-16	query	true	string
mobileUser	用户手机号码	query	true	string
nick	用户昵称	query	true	string
X-Token	管理员登录凭证	header	true
pingtuanJoiner	团号	query	false
pingtuanId	拼团ID	query	false
orderId	订单ID	query	false
goodsId	商品ID	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

拼团设置详情

接口地址:/apifmUser/pingtuanSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	拼团设置ID	query	true	integer(int32)
goodsId	商品id	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

订单模块

删除评价图片

接口地址:/apifmUser/order/delReputationPic

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	评价图片所在记录的ID	query	true	integer(int64)
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取所有快递公司

接口地址:/apifmUser/order/expressCompanies

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

CMS模块

搜索文章分类

接口地址:/apifmUser/newsCategory/search

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
ids	多个ID用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true
shopId	门店ID	query	true
name	名称	query	true
id	id	query	false
type	自定义类型，32个字符以内	query	false
pid	上级分类ID， 0 代表顶级分类	query	false
key	分类编号	query	false
icon	分类图标	query	false
pic	封面图片	query	false
paixu	排序	query	false
isUse	是否启用，true 或者 false	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

文章分类添加-修改

接口地址:/apifmUser/newsCategory/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
name	名称	query	true
id	添加不传；修改传需要修改的记录id	query	false
type	自定义类型，32个字符以内	query	false
remark	备注	query	false
pid	上级分类ID， 0 代表顶级分类	query	false
key	分类编号	query	false
icon	分类图标	query	false
paixu	排序	query	false
isUse	是否启用，true 或者 false	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

文章分类列表

接口地址:/apifmUser/newsCategory/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
shopId	门店ID	query	true	integer(int32)
showExtJson	显示扩展属性	query	true	boolean
isUse	是否加载可用的	query	true	boolean
pid	上级分类ID，获取全部分类传0	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除文章分类

接口地址:/apifmUser/newsCategory/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	分类ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

审核通过

接口地址:/apifmUser/comment/vet

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	留言id，多个ID用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

接口地址:/apifmUser/comment/reply

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	留言id	query	true	integer(int64)
reply	回复内容	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

留言-评论列表

接口地址:/apifmUser/comment/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
titleLike	type==3的时候，搜索cms文章标题关键字	query	true	string
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间起,格式 2018-05-16	query	true	string
dateReplyBegin	回复时间起,格式 2018-05-16	query	true	string
dateReplyEnd	回复时间起,格式 2018-05-16	query	true	string
showExtJson	显示扩展属性	query	true	boolean
X-Token	管理员登录凭证	header	true
type	0 网站留言 1 意见反馈 2 投诉建议 3 CMS文章评论 4 接口申请 5 预约/活动/报名 6 商城订单	query	false
refId	业务ID，比如文章id	query	false
pid	引用的留言ID	query	false
status	0 待审核 1 已审核 2 已回复	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除评论、留言、投诉建议

接口地址:/apifmUser/comment/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	留言id，多个ID用英文逗号分割	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加留言-评论

接口地址:/apifmUser/comment/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
extJsonStr	属性信息,JSON格式	query	true	string
X-Token	管理员登录凭证	header	true
content	留言/评论内容	query	true
latitude	地图坐标纬度	query	true
longitude	地图坐标经度	query	true
refId	业务ID，比如文章id	query	false
pid	引用的留言ID	query	false
type	0 网站留言 1 意见反馈 2 投诉建议 3 CMS文章评论 4 接口申请 5 预约/活动/报名 6 商城订单	query	false
file	文件附件链接，可传图片、文件	query	false
streetId	所属街道ID	query	false
communityId	所属社区/村ID	query	false
mobile	联系电话	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

单页添加-修改

接口地址:/apifmUser/cmsPage/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
extJsonStr	扩展属性的JSON格式数据	query	true	string
X-Token	管理员登录凭证	header	true
key	编号	query	true
title	标题	query	true
content	内容	query	true
id	添加不传；修改传需要修改的记录id	query	false
type	0 富文本编辑器 1纯文本编辑器	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

单页列表

接口地址:/apifmUser/cmsPage/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	发布时间起,格式 2018-05-16	query	true	string
dateAddEnd	发布时间止,格式 2018-05-16	query	true	string
dateUpdateBegin	修改时间起,格式 2018-05-16	query	true	string
dateUpdateEnd	修改时间止,格式 2018-05-16	query	true	string
titleLike	标题	query	true	string
X-Token	管理员登录凭证	header	true
id	ID	query	false
type	0 富文本编辑器 1纯文本编辑器	query	false
key	编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除单页

接口地址:/apifmUser/cmsPage/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

公告添加-修改

接口地址:/apifmUser/cmsNotice/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
type	类型	query	true
title	标题	query	true
isShow	是否显示	query	true
isTop	是否置顶	query	true
content	内容	query	true
id	添加不传；修改传需要修改的记录id	query	false
pic	封面图片	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

公告列表

接口地址:/apifmUser/cmsNotice/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	发布时间起,格式 2018-05-16	query	true	string
dateAddEnd	发布时间止,格式 2018-05-16	query	true	string
titleLike	标题	query	true	string
X-Token	管理员登录凭证	header	true
id	ID	query	false
type	公告类型	query	false
isShow	是否展示	query	false
isTop	是否置顶	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除公告

接口地址:/apifmUser/cmsNotice/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

文章分类详情

接口地址:/apifmUser/newsCategory/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	分类id	query	true	integer(int32)
categoryKey	分类编号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

留言-评论详情

接口地址:/apifmUser/comment/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	评论记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

单页详情

接口地址:/apifmUser/cmsPage/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

使用key获取单页详情

接口地址:/apifmUser/cmsPage/info/key

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
key	编号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

公告详情

接口地址:/apifmUser/cmsNotice/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

MTJ

审核通过

接口地址:/apifmUser/mtjTransfer/success

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

审核不通过

接口地址:/apifmUser/mtjTransfer/refuse

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mtj转账记录列表

接口地址:/apifmUser/mtjTransfer/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	mtj转账记录	query	false	MtjTransfer	MtjTransfer
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uidOut	转出用户		false	integer(int64)
uidIn	转入用户		false	integer(int64)
number	赚账数量		false	number
fee	手续费		false	number
numberActual	实际到账		false	number
remark	备注		false	string
status	0待审核 1成功 2失败		false	integer(int32)
dateAdd	转账日期		false	string(date-time)
dateUpdate	变更时间		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mtj设置

接口地址:/apifmUser/mtjSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数	mtj配置	query	false	MtjSet	MtjSet
id	商户ID		false	integer(int32)
signGot	签到赠送		false	number
signGotFx1	1级分销商赠送		false	number
signGotFx2	2级分销商赠送		false	number
signGotFx3	3级分销商赠送		false	number
transferFee	转账手续费，填 1为 1%		false	number

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除mtj配置

接口地址:/apifmUser/mtjSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

调整用户MTJ

接口地址:/apifmUser/mtj/modify

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	用户编号(用户编号和手机号码至少传一项)	query	true	integer(int32)
mobile	手机号码(用户编号和手机号码至少传一项)	query	true	string
mtj	调整数量(减少请填写负数)	query	true	number
remark	备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户贡献值列表

接口地址:/apifmUser/mtj/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
mobile	用户手机号码	query	true	string
nick	用户昵称	query	true	string
orderBy	排序规则：balanceUp 余额从小到大；balanceDown 余额从大到小；freezeUp 冻结从小到大；freezeDown 冻结从大到小；	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	用户贡献值	query	false	Mtj	Mtj
id	用户ID		false	integer(int64)
userId	商户ID		false	integer(int32)
balance	余额		false	number
freeze	冻结		false	number
bonusDate	最后分红时间		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

读取mtj设置信息

接口地址:/apifmUser/mtjSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

用户贡献值记录

MTJ明细s列表

接口地址:/apifmUser/mtjLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin		query	true	string
dateAddEnd		query	true	string
mobile		query	true	string
nick		query	true	string
X-Token	管理员登录凭证	header	true
其他参数	用户贡献值记录	query	false	MtjLog	MtjLog
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	用户ID		false	integer(int64)
type	0 管理员调整 10 签到获得 11 签到返佣 20 购买商品 21 商品返佣		false	integer(int32)
behavior	0 收入 1 支出		false	integer(int32)
number	交易数量		false	number
balance	余额		false	number
freeze	冻结		false	number
dateAdd	交易时间		false	string(date-time)
remark	备注		false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

系统日志

列表

接口地址:/apifmUser/logMerchant/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数		query	false	LogMerchant	LogMerchant
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
username	管理员账号		false	string
name	管理员名称		false	string
module	模块名称		false	string
content	操作内容		false	string
dateAdd	操作时间		false	string(date-time)
ip	操作IP		false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

添加

接口地址:/apifmUser/logMerchant/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数		query	false	LogMerchant	LogMerchant
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
username	管理员账号		false	string
name	管理员名称		false	string
module	模块名称		false	string
content	操作内容		false	string
dateAdd	操作时间		false	string(date-time)
ip	操作IP		false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

自定义JSON

JSON数据添加-修改

接口地址:/apifmUser/jsonBase/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	添加不传；修改传需要修改的记录id	query	true	integer(int64)
type	类型	query	true	string
refId	关联id	query	true	integer(int64)
content	JSON数据	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

JSON数据列表

接口地址:/apifmUser/jsonBase/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页显示多少数据	query	true	integer(int64)
dateUpdateBegin	更新时间起,格式 2018-05-16	query	true	string
dateUpdateEnd	更新时间止,格式 2018-05-16	query	true	string
contentLike	关键词	query	true	string
mobile	手机号码	query	true	string
nick	昵称	query	true	string
X-Token	管理员登录凭证	header	true
id	ID	query	false
uid	用户编号	query	false
type	类型	query	false
refId	关联id	query	false
其他参数		query	false	JsonBase	JsonBase
id	主键		false	integer(int64)
userId	商家编号		false	integer(int32)
uid	用户编号		false	integer(int64)
refId	外键ID		false	integer(int64)
type	自定义类型		false	string
content	json格式数据		false	object
dateAdd	添加时间		false	string(date-time)
dateUpdate	更新时间		false	string(date-time)
isTop	是否置顶		false	boolean
isHighlight	是否突出显示		false	boolean

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除JSON数据

接口地址:/apifmUser/jsonBase/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

JSON数据详情

接口地址:/apifmUser/jsonBase/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	id	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mqtt

mqtt发送消息

接口地址:/apifmUser/iotMqtt/sendMsg

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
username	账号	query	true	string
content	消息内容	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mqtt账号重置密码

接口地址:/apifmUser/iotMqtt/resetPwd

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
username	账号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mqtt账号修改备注

接口地址:/apifmUser/iotMqtt/remark

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
username	账号	query	true	string
remark	备注内容	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mqtt账号列表

接口地址:/apifmUser/iotMqtt/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	mqtt账号	query	false	IotMqtt	IotMqtt
username	用户名		false	string
pwd	密码		false	string
salt	秘钥加盐		false	string
userId	商户ID		false	integer(int32)
remark	备注		false	string
status	0 正常； 1 禁用; 2 已到期		false	integer(int32)
dataAdd	添加时间		false	string(date-time)
dateEnd	到期时间		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除mqtt账号

接口地址:/apifmUser/iotMqtt/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
username	账号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

创建mqtt账号

接口地址:/apifmUser/iotMqtt/create

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数	mqtt账号	query	false	IotMqtt	IotMqtt
username	用户名		false	string
pwd	密码		false	string
salt	秘钥加盐		false	string
userId	商户ID		false	integer(int32)
remark	备注		false	string
status	0 正常； 1 禁用; 2 已到期		false	integer(int32)
dataAdd	添加时间		false	string(date-time)
dateEnd	到期时间		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

mqtt账号详情

接口地址:/apifmUser/iotMqtt/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
username	账号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品寄存表

商品寄存表添加

接口地址:/apifmUser/goodsJicun/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
dateExpiredStr	到期日期，格式: 2021-08-03	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	商品寄存表	query	false	GoodsJicun	GoodsJicun
id	主键		false	integer(int64)
userId	商户id		false	integer(int32)
uid	用户id		false	integer(int64)
goodsId	商品id		false	integer(int64)
goodsName	商品名称		false	string
year	年份		false	string
sku	规格		false	string
number	数量		false	integer(int32)
ck	仓储地		false	string
dateAdd	寄存时间		false	string(date-time)
dateTake	取回时间		false	string(date-time)
dateExpired	过期时间		false	string(date-time)
status	0 寄存中 11 取货中 1 已取回 2 已过期		false	integer(int32)
categoryId	分类id		false	integer(int32)
pic	商品图片		false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品寄存修改状态

接口地址:/apifmUser/goodsJicun/modifyStatus

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	记录ID	query	true	integer(int64)
status	0 寄存中 11 取货中 1 已取回 2 已过期	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品寄存表列表

接口地址:/apifmUser/goodsJicun/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
mobile	手机号码	query	true	string
nickLike	昵称	query	true	string
dateAddBegin	寄存时间起	query	true	string
dateAddEnd	寄存时间止	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	商品寄存表	query	false	GoodsJicun	GoodsJicun
id	主键		false	integer(int64)
userId	商户id		false	integer(int32)
uid	用户id		false	integer(int64)
goodsId	商品id		false	integer(int64)
goodsName	商品名称		false	string
year	年份		false	string
sku	规格		false	string
number	数量		false	integer(int32)
ck	仓储地		false	string
dateAdd	寄存时间		false	string(date-time)
dateTake	取回时间		false	string(date-time)
dateExpired	过期时间		false	string(date-time)
status	0 寄存中 11 取货中 1 已取回 2 已过期		false	integer(int32)
categoryId	分类id		false	integer(int32)
pic	商品图片		false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商品寄存记录删除

接口地址:/apifmUser/goodsJicun/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	记录ID,多个ID用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

FSM

fsm设置添加-编辑

接口地址:/apifmUser/fsmSetting/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数	fsm设置	query	false	FsmSetting	FsmSetting
id	商户ID		false	integer(int32)
saleLevelId	经销商等级ID		false	integer(int32)
installerLevelId	安装人员等级ID		false	integer(int32)
orderSaleQiyewxRobotToken	销售报备订单企微提醒		false	string
orderInstallQiyewxRobotToken	安装订单企微提醒		false	string
orderRepairQiyewxRobotToken	售后工单企微提醒		false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设备型号管理添加-编辑

接口地址:/apifmUser/fsmDeviceModel/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
buyMaxNumberList	对应的用户标签的限购数量数组字符串:[{tag: "零售商", buyMaxNumber: 100}]	query	true	string
subsidyPriceList	对应的几线城市安装补贴金额数组字符串:[{cityLevel: 1, price: 15}]	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	设备型号管理	query	false	FsmDeviceModel	FsmDeviceModel
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
name	名称		false	string
remark	备注		false	string
status	状态		false	integer(int32)
buyMaxNumber	最大限购数量，0 不限		false	integer(int32)
paixu	排序		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设备型号管理列表

接口地址:/apifmUser/fsmDeviceModel/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	设备型号管理	query	false	FsmDeviceModel	FsmDeviceModel
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
name	名称		false	string
remark	备注		false	string
status	状态		false	integer(int32)
buyMaxNumber	最大限购数量，0 不限		false	integer(int32)
paixu	排序		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除设备型号管理

接口地址:/apifmUser/fsmDeviceModel/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

fsm设置详情

接口地址:/apifmUser/fsmSetting/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设备型号管理详情

接口地址:/apifmUser/fsmDeviceModel/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

订单项目报备

订单项目报备审核

接口地址:/apifmUser/fsmSaleOrder/vet

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
status	1审核通过、2审核不通过	query	true	integer(int32)
vetRemark	审核备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

单独设置经销商设备型号的限购数量

接口地址:/apifmUser/fsmSaleOrder/setDeviceModelBuyMaxNumberUser

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
uid	经销商用户ID	query	true	integer(int64)
content	设置内容，不传改字段，将清空用户特殊设置: [{"modelId": 123, "buyMaxNumber": 10}]	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改报备数量

接口地址:/apifmUser/fsmSaleOrder/modifyNumber

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
number	报备数量	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改型号

接口地址:/apifmUser/fsmSaleOrder/modifyDeviceModelId

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
deviceModelId	设备型号ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

订单项目报备列表

接口地址:/apifmUser/fsmSaleOrder/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
mobile	手机号码	query	true	string
nickLike	昵称	query	true	string
deviceModelLike	设备型号关键词	query	true	string
dateAddBegin	报备时间起	query	true	string
dateAddEnd	报备时间止	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	订单项目报备	query	false	FsmSaleOrder	FsmSaleOrder
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
orderNumber	订单号		false	string
uid	用户编号		false	integer(int64)
deviceModelId	设备型号ID		false	integer(int32)
provinceId	省份		false	string
cityId	城市		false	string
districtId	区县		false	string
streetId	街道		false	string
customerName	客户名称		false	string
address	详细地址		false	string
number	报备数量		false	integer(int32)
status	0待审核、1审核通过、2审核不通过、3已安装、4已补贴、5 已发货		false	integer(int32)
dateAdd	报备时间		false	string(date-time)
dateVet	审核时间		false	string(date-time)
dateInstall	预估安装时间		false	string(date-time)
dateSubsidy	补贴时间		false	string(date-time)
vetRemark	审核说明		false	string
linkMobile	项目联系人电话		false	string
trackingNumber	发货单号		false	string
trackingRemark	发货备注		false	string
provinceName			false	string
cityName			false	string
districtName			false	string
streetName			false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

发货

接口地址:/apifmUser/fsmSaleOrder/fahuo

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
trackingNumber	发货单号	query	true	string
trackingRemark	发货备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除订单项目报备

接口地址:/apifmUser/fsmSaleOrder/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	多个ID用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

反审

接口地址:/apifmUser/fsmSaleOrder/backVet

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	订单ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

补单

接口地址:/apifmUser/fsmSaleOrder/add

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
mobile	经销商手机号	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	订单项目报备	query	false	FsmSaleOrder	FsmSaleOrder
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
orderNumber	订单号		false	string
uid	用户编号		false	integer(int64)
deviceModelId	设备型号ID		false	integer(int32)
provinceId	省份		false	string
cityId	城市		false	string
districtId	区县		false	string
streetId	街道		false	string
customerName	客户名称		false	string
address	详细地址		false	string
number	报备数量		false	integer(int32)
status	0待审核、1审核通过、2审核不通过、3已安装、4已补贴、5 已发货		false	integer(int32)
dateAdd	报备时间		false	string(date-time)
dateVet	审核时间		false	string(date-time)
dateInstall	预估安装时间		false	string(date-time)
dateSubsidy	补贴时间		false	string(date-time)
vetRemark	审核说明		false	string
linkMobile	项目联系人电话		false	string
trackingNumber	发货单号		false	string
trackingRemark	发货备注		false	string
provinceName			false	string
cityName			false	string
districtName			false	string
streetName			false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

订单项目报备详情

接口地址:/apifmUser/fsmSaleOrder/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查看经销商限购设置及剩余可报备数量

接口地址:/apifmUser/fsmSaleOrder/buyMaxNumberAndLeftNumber

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
uid	经销商用户ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

售后工单

回厂

接口地址:/apifmUser/fsmRepair/returnFactory

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
trackingNumber	回厂单号	query	true	string
content	回厂日期	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修复

接口地址:/apifmUser/fsmRepair/repair

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
trackingNumber	修复产品发出单号	query	true	string
content	修复产品发出日期	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

信息不全退回

接口地址:/apifmUser/fsmRepair/refuse

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
content	备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

维修报价

接口地址:/apifmUser/fsmRepair/quotation

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
content	报告内容	query	true	string
pdf	pdf文件	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

维修完成

接口地址:/apifmUser/fsmRepair/maintenance

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
content	维修完成时间	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

售后工单列表

接口地址:/apifmUser/fsmRepair/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	售后工单	query	false	FsmRepair	FsmRepair
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	报修人用户编号		false	integer(int64)
orderNumber	订单号		false	string
caseNumber	系统服务单号		false	string
type	0 产品故障报修 1 FRP		false	integer(int32)
deviceModelId	设备型号ID		false	integer(int32)
logisticsCode	溯源码		false	string
reportingUnit	报修人姓名		false	string
picProduct	铭牌照片		false	string
picInstall	现场照片，多张用逗号分隔		false	string
content	故障描述		false	string
dateAdd	报修时间		false	string(date-time)
dateUpdate	修改时间		false	string(date-time)
status	0 待处理 1 已受理 2 驳回 3 已完结		false	integer(int32)
vetRemark	审核说明		false	string
batchNumber	批次号		false	string
productSn	产品编号		false	string
productName	产品名称		false	string
customerAddress	客户地址		false	string
useTimes	使用时长		false	string
typeStr			false	string
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

发货

接口地址:/apifmUser/fsmRepair/fahuo

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
trackingNumber	发出单号	query	true	string
content	发出日期	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

关单

接口地址:/apifmUser/fsmRepair/close

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
content	备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

检测报告

接口地址:/apifmUser/fsmRepair/check

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
content	报告内容	query	true	string
pdf	pdf文件	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

建号【填写系统服务单号】

接口地址:/apifmUser/fsmRepair/caseNumber

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
caseNumber	系统服务单号	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

售后工单详情

接口地址:/apifmUser/fsmRepair/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

安装订单

安装订单审核

接口地址:/apifmUser/fsmInstallOrder/vet

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
status	1审核通过、2审核不通过	query	true	integer(int32)
vetRemark	审核备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

批量设置为已补贴

接口地址:/apifmUser/fsmInstallOrder/subsidy

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
orderNumber	订单号，多个用英文逗号分隔	query	true	array	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

安装数据统计

接口地址:/apifmUser/fsmInstallOrder/statistics

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
provinceId	省份ID	query	true	string
cityId	城市ID	query	true	string
deviceModelId	设备型号ID，多个型号用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

修改型号

接口地址:/apifmUser/fsmInstallOrder/modifyDeviceModelId

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	订单ID	query	true	integer(int64)
deviceModelId	设备型号ID	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

安装订单列表

接口地址:/apifmUser/fsmInstallOrder/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
mobile	手机号码	query	true	string
nickLike	注册用户的昵称模糊搜索	query	true	string
deviceModelLike	设备型号关键词	query	true	string
dateAddBegin	报备时间起	query	true	string
dateAddEnd	报备时间止	query	true	string
dealerNameLike	经销商名称模糊搜索	query	true	string
departmentId	用户所属部门ID	query	true	integer(int32)
dateVetBegin	审核时间起	query	true	string
dateVetEnd	审核时间止	query	true	string
userTag	用户标签	query	true	string
X-Token	管理员登录凭证	header	true
logisticsCode	溯源码	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除安装订单

接口地址:/apifmUser/fsmInstallOrder/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	多个ID用英文逗号分隔	query	true	array	integer
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

安装订单详情

接口地址:/apifmUser/fsmInstallOrder/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

工作流

工作流添加-编辑

接口地址:/apifmUser/flowInfo/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数	工作流	query	false	FlowInfo	FlowInfo
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
name	名称		false	string
status	0正常 1禁用		false	integer(int32)
content	工作流		false	string
dateAdd	添加时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

工作流列表

接口地址:/apifmUser/flowInfo/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	工作流	query	false	FlowInfo	FlowInfo
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
name	名称		false	string
status	0正常 1禁用		false	integer(int32)
content	工作流		false	string
dateAdd	添加时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除工作流

接口地址:/apifmUser/flowInfo/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

工作流详情

接口地址:/apifmUser/flowInfo/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

云存储配置

接口地址:/apifmUser/dfsConfig/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
参数说明	自定义文件存储配置	query	false	DfsConfig	DfsConfig
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
type	'0 七牛 1 又拍云 2 阿里云 3 腾讯云 4 华为云obs 5 天翼云		false	integer(int32)
apiDomain	接口地址		false	string
domain	访问域名		false	string
bucket	空间名		false	string
userName	用户名		false	string
password	密码		false	string
isDefault	是否默认使用该配置		false	boolean
dateAdd	添加时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)
endpoint	阿里云使用		false	string
isDeleteRemoteFile	是否删除云端文件		false	boolean
typeStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

启用云存储配置

接口地址:/apifmUser/dfsConfig/enable

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除云存储配置

接口地址:/apifmUser/dfsConfig/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录编号	query	true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

云存储配置列表

接口地址:/apifmUser/dfsConfig/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

云存储配置详情

接口地址:/apifmUser/dfsConfig/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

购买课程

课程场次添加-修改

接口地址:/apifmUser/courseSession/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
id	添加不传；修改传需要修改的记录id	query	false
shopId	门店ID	query	false
courseId	课程ID	query	false
name	场次名称	query	false
time	场次时间	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除课程场次

接口地址:/apifmUser/courseSession/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	场次ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程信息添加-编辑

接口地址:/apifmUser/courseInfo/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
pics	课程图片数组	query	true	array	string
deleteOldPics	修改课程的时候是否删除原来的课程图片，true 为删除，默认不删除	query	true	boolean
dateStartStr	开始时间格式：2021-07-01	query	true	string
dateEndStr	结束时间格式：2021-07-31	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	课程信息	query	false	CourseInfo	CourseInfo
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
categoryId	CMS类目，预留后期使用		false	integer(int32)
type	0 线上； 1 线下		false	integer(int32)
paixu	排序		false	integer(int32)
name	名称		false	string
subName	别名		false	string
pic	图片		false	string
dayStart	开始时间		false	string(date-time)
dayEnd	结束时间		false	string(date-time)
price	价格		false	number
minutes	课程时长（分）		false	integer(int32)
numberViews	浏览量		false	integer(int32)
numberBuy	报名人数，成功才计算		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程列表

接口地址:/apifmUser/courseInfo/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
nameLike	课程名称模糊搜索	query	true	string
X-Token	管理员登录凭证	header	true
其他参数	课程信息	query	false	CourseInfo	CourseInfo
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
categoryId	CMS类目，预留后期使用		false	integer(int32)
type	0 线上； 1 线下		false	integer(int32)
paixu	排序		false	integer(int32)
name	名称		false	string
subName	别名		false	string
pic	图片		false	string
dayStart	开始时间		false	string(date-time)
dayEnd	结束时间		false	string(date-time)
price	价格		false	number
minutes	课程时长（分）		false	integer(int32)
numberViews	浏览量		false	integer(int32)
numberBuy	报名人数，成功才计算		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除课程信息

接口地址:/apifmUser/courseInfo/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

设置课程详细介绍

接口地址:/apifmUser/courseContent/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
courseId	课程ID	query	true	integer(int64)
type	0 上课地点； 1 课程介绍；2 课程须知	query	true	integer(int32)
content	详细内容	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程购买记录设置为已使用

接口地址:/apifmUser/courseBuyLog/use

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程购买记录列表

接口地址:/apifmUser/courseBuyLog/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	课程购买记录	query	false	CourseBuyLog	CourseBuyLog
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
uid	用户ID		false	integer(int64)
courseId	课程ID		false	integer(int64)
courseName	课程名称		false	string
pic	图片		false	string
shopId	门店ID		false	integer(int32)
sessionId	场次ID		false	integer(int32)
status	-1 已关闭； 0 待支付； 1 已支付； 2 已核销（已使用）；3 已过期；		false	integer(int32)
name	姓名		false	string
mobile	手机号码		false	string
number	购买数量		false	integer(int32)
orderNumber	订单号		false	string
hxNumber	核销密码		false	string
payAmount	支付金额		false	number
payBalance	余额支付金额		false	number
payOnline	在线支付金额		false	number
dateAdd	添加时间		false	string(date-time)
dateUpdate	编辑时间		false	string(date-time)
statusStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程购买记录设置为已过期

接口地址:/apifmUser/courseBuyLog/expire

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除课程购买记录

接口地址:/apifmUser/courseBuyLog/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	记录ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程场次列表

接口地址:/apifmUser/courseSession/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
courseId	课程ID	query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程场次详情

接口地址:/apifmUser/courseSession/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

课程详情

接口地址:/apifmUser/courseInfo/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int64)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

资源包管理

查看购买的资源包

接口地址:/apifmUser/centerUserResourceBundle/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间起,格式 2018-05-16	query	true	string
dateUpdateBegin	更新时间起,格式 2018-05-16	query	true	string
dateUpdateEnd	更新时间止,格式 2018-05-16	query	true	string
X-Token	管理员登录凭证	header	true
isPay	是否已支付	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除资源包

接口地址:/apifmUser/centerUserResourceBundle/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	资源包id	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

查看资源包详情

接口地址:/apifmUser/centerUserResourceBundle/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id	资源包id	query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

购买资源包-PC支付宝付款

接口地址:/apifmUser/centerUserResourceBundle/buy/pc

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

vod_100:100元视频包;vod_500:500元视频包,vod_1000:1000元视频包,vod_2000:2000元视频包

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
key	资源包编码	query	true	string
payType	alipay wx	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

购买资源包-手机支付宝付款

接口地址:/apifmUser/centerUserResourceBundle/buy/mobile

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

vod_100:100元视频包;vod_500:500元视频包,vod_1000:1000元视频包,vod_2000:2000元视频包

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
key	资源包编码	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

代理商模块

调整商户余额

接口地址:/apifmUser/centerUserCash/modify

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	商户编号(商户编号和商户账号至少传一项)	query	true	integer(int32)
mobile	商户账号(商户编号和商户账号至少传一项)	query	true	string
money	调整金额，扣除金额使用负数	query	true	number
remark	备注	query	true	string
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商户资产列表

接口地址:/apifmUser/centerUserCash/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
mobile	商户账号	query	true	string
realName	商户名称	query	true	string
orderBy	排序规则：balanceUp 余额从小到大；balanceDown 余额从大到小；freezeUp 冻结从小到大；freezeDown 冻结从大到小；scoreUp 积分从小到大；scoreDown 积分从大到小；	query	true	string
X-Token	管理员登录凭证	header	true
id	商户编号	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商户资金流水列表

接口地址:/apifmUser/centerUserCash/cashlogs

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	支付时间起,格式 2018-05-16	query	true	string
dateAddEnd	支付时间起,格式 2018-05-16	query	true	string
mobile	商户账号	query	true	string
realName	商户名称	query	true	string
X-Token	管理员登录凭证	header	true
userId	商户编号	query	false
behavior	0 收入； 1 支出	query	false
type	交易类型 0 充值 1 返佣 2 提现 3 购买插件 4 管理员调整	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商户管理员和角色的关系表

商户管理员和角色的关系表添加-编辑

接口地址:/apifmUser/centerUserAdminRoles/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true
其他参数	商户管理员和角色的关系表	query	false	CenterUserAdminRoles	CenterUserAdminRoles
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
aid	管理员ID		false	integer(int32)
rid	角色ID		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商户管理员和角色的关系表列表

接口地址:/apifmUser/centerUserAdminRoles/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
X-Token	管理员登录凭证	header	true
其他参数	商户管理员和角色的关系表	query	false	CenterUserAdminRoles	CenterUserAdminRoles
id	主键		false	integer(int32)
userId	商户ID		false	integer(int32)
aid	管理员ID		false	integer(int32)
rid	角色ID		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除商户管理员和角色的关系表

接口地址:/apifmUser/centerUserAdminRoles/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

商户管理员和角色的关系表详情

接口地址:/apifmUser/centerUserAdminRoles/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
id		query	true	integer(int32)
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

上传文件管理

存储包使用明细

接口地址:/apifmUser/apiExtDfs/resourceLog

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间起,格式 2018-05-16	query	true	string
type	0 购买存储包; 1 系统赠送; 2 图片空间抵扣；3 视频点播抵扣	query	true	integer(int32)
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

保护文件

接口地址:/apifmUser/apiExtDfs/protect

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	多条记录ID，用英文逗号分隔	query	true	array	integer
protect	是否保护	query	true	boolean
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

批量修改分类

接口地址:/apifmUser/apiExtDfs/modifyCategory

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids	多条记录ID，用英文逗号分隔	query	true	array	integer
categoryId	分类ID	query	true	integer(int32)
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

上传文件列表

接口地址:/apifmUser/apiExtDfs/list

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
page	获取第几页数据	query	true	integer(int64)
pageSize	每页获取几条数据	query	true	integer(int64)
dateAddBegin	添加时间起,格式 2018-05-16	query	true	string
dateAddEnd	添加时间起,格式 2018-05-16	query	true	string
urlLike	文件链接	query	true	string
originalNameLike	文件名	query	true	string
ids	多个记录ID，用英文逗号分隔	query	true	array	integer
paixu	sizeAsc 容量升序; sizeDesc 容量倒序	query	true	string
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false
其他参数	上传文件记录表	query	false	DfsFiles	DfsFiles
id	主键		false	integer(int64)
userId	商户ID		false	integer(int32)
configId	自定义配置记录ID		false	integer(int64)
fileType	0 图片 1 音频 2 其他		false	integer(int32)
suffix	后缀名(小写) .jpg		false	string
size	容量（字节）		false	integer(int64)
urlNoDomain	没有域名的地址		false	string
urlFull	完整地址		false	string
dateAdd	添加时间		false	string(date-time)
dateExpire	到期时间		false	string(date-time)
categoryId	图库分类id		false	integer(int32)
protect	受保护的，用户不能删除		false	boolean
originalName	原始文件名		false	string
isVet	是否已审核		false	boolean
sizeStr			false	string
fileTypeStr			false	string

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除文件

接口地址:/apifmUser/apiExtDfs/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ids		query	true	array	integer
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

空间使用情况

接口地址:/apifmUser/apiExtDfs/statistics

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	后台管理员登录的 xtoken，和Authorization 二选一	header	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

支付宝小程序

配置appid和privateKey

接口地址:/apifmUser/aliappSet/save

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须
X-Token	管理员登录凭证	header	true
appid	appid	query	true
privateKey	privateKey	query	true
encryptKey	信息解密AES 解密密钥	query	false

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

删除当前支付宝小程序配置

接口地址:/apifmUser/aliappSet/del

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

获取当前appid和privateKey配置

接口地址:/apifmUser/aliappSet/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
X-Token	管理员登录凭证	header	true

响应状态:

状态码	说明	schema
200	OK	JSONResultCode

响应参数:

参数名称	类型	schema
code	integer(int32)	integer(int32)
msg	string
data	object

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {}
}

439 KiB Raw Permalink Blame History Unescape Escape

Apifm-common

设置类接口

获得购买vip地址信息

使用vip卡券激活(续费)

运营商的客户自己续费链接

设置标签机标签纸尺寸

清空打印任务

图片验证码设置

系统参数设置

修改参数设置

系统参数设置列表

删除系统参数

扩展地址添加-编辑

扩展地址列表

删除扩展地址

读取飞鹅打印机状态

飞鹅打印机列表

读取图片验证码设置

批量获取多个参数设置值

系统参数设置详情

扩展地址详情

登录及授权

注册获取短信验证码

注册保存【手机方式】

注册保存【邮箱方式】

注册获取邮箱验证码

子账号登录[域名]

通过前端用户的token换取X-TOKEN

门店登陆接口

子账号登录[商户号]

手机号码登录

通过商户号和秘钥登录获取X-TOKEN

邮箱登录获取X-TOKEN

忘记密码发送短信验证码

重置新密码

重置新密码【通过邮件验证码】

修改登录密码

添加-修改角色

所有的角色列表

删除角色

启用管理员

禁用管理员

添加-修改管理员

重置管理员密码

区域管理员列表

平台管理员列表

删除管理员

退出登录

获取角色详情

获取所有的权限列表

管理员详情

插件管理

获得购买插件信息

工厂设置

获得购买模块套餐信息

获取所有工厂模块列表

vip卡券列表

推广返佣申请提现

设置推广返佣支付宝账号

添加-修改我的客户信息

我的客户列表

删除我的客户

卸载模块

一键移除所有模块

已安装模块列表

安装模块

我开通的插件列表

检测是否开通了某插件

我的客户详情

暂时模块可购买的套餐列表

预约报名

预约-报名设置为报名成功

预约-报名记录标记为已服务

预约-报名用户管理

预约-报名记录删除

取消预约

预约报名设置添加-修改

预约报名数据列表

删除预约报名项目

439 KiB

Raw Permalink Blame History