注册

open.shopweb.user.saveUserByOpenPlatform （新增/修改开放平台用户）

通过开放平台新增/修改人员

接口描述 #

环境 接口方法 提交方式 是否需要签名 HTTP请求路由
正式环境 open.shopweb.user.saveUserByOpenPlatform POST true http://cloudapi.ovopark.com/cloud.api

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.shopweb.user.saveUserByOpenPlatform
_sm String 是 100 签名算法 md5,sha1 md5
_requestMode String 是 100 请求方式post,get POST
_version String 是 100 版本号 v1
_timestamp String 是 100 时间戳 yyyyMMddHHmmss格式
_sig String 是 32 签名token 根据签名算法生成，详情见签名算法规则
_format String 否 10 format类型 目前默认仅支持json

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
json JSON √ 99 json请求类型 查看
id int × 0 ID不传为新增
userName string √ 0 用户帐号
showName string √ 0 显示名称
phone string × 0 电话
mobilePhone string × 0 移动电话
mail string × 0 邮箱
localelan string × 0 区域语言
pId int × 0 上级用户的id
validateDate date × 0 创建时间
thumbUrl string × 0 用户头像
groupId int √ 0 用户所属企业分组
isSingleSign int × 0 新增字段手机APP中是否是单点登录
employeeNumber string × 0 工号
pyName string × 0 拼音名
pyFirst string × 0 拼音首字母
isFrozen int × 0 0正常 1被冻结
staffImageUrl string × 0 员工头像
position string × 0 职位，岗位
validateStatus int × 0 有效状态 0 正常 1 已过期 2 即将过期
franchiseeType int × 0 加盟商类型 0 普通账号 1 加盟商 2 加盟商员工
franchiseeTime date × 0 加盟日期
contractStartTime date × 0 合同开始时间
contractEndTime date × 0 合同结束时间
contractUrl JSON × 0 合同URL【集合】 查看
roleIds JSON × 0 角色id【集合】 查看
configureContents JSON × 0 自定义字段【集合】 查看
roleDepStr JSON × 0 角色对应 门店【集合】 查看
needSms int × 0 登录是否需要短信验证码验证
isDelFranchiseeContract int × 0 是否 删除加盟商合同 0 未删除 1 已删除
depIds JSON × 0 门店id【集合】 查看
shopIds JSON × 0 门店权限 店铺id【集合】 查看
orgPermissionIds JSON × 0 门店权限 组织架构id【集合】 查看
orgPermissionIdThirdOrgId JSON × 0 门店权限 部门编码【集合】 查看
userOrganizeIds JSON × 0 通讯录 组织架构id 查看
userOrganizeDepIds JSON × 0 通讯录 传 门店id【集合】 查看
userOrganizeShopIds JSON × 0 通讯录 传 门店shopId【集合】 查看
userOrganizeThirdOrgIds JSON × 0 通讯录 传 部门编码【集合】 查看
userDepList JSON × 0 作为店长的门店id 集合 查看
userShopIdList JSON × 0 作为店长的店铺id 集合 查看
password string √ 0 密码（修改人员信息是不需要传）
orgPermissionNull boolean × 0 清空组织架构权限和店长 默认 false 要清空 传 true
userOrganizeNull boolean × 0 清空通讯录权限 默认 false要清空 传 true

公共响应参数 #

参数 类型 最大长度 描述 示例值
stat JSON - 网关状态(具体参数描述如下：) 查看
stat.cid String 100 http请求的标识符
stat.code String 100 网关返回码
stat.codename String 100 网关返回码名称
stat.systime String Long 接口调用的当前时间
result String 100 接口返回提示信息
data JSON - 接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

参数名称 类型 是否一定返回 返回最大长度 描述 示例值
data JSON × 11 返回data 查看

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
SUCCESS 0 调用成功
KEY_NOTNULL 1 _akey和不能为空 接口调用时传入_akey参数
KEY_UNLAWFUL 2 _akey不合法 key是非法的,传入正确的key
KEY_HAS_EXPIRED 3 _akey已过期 请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL 4 _sm参数不能为空 接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST 5 _sm类型不存在 目前仅支持md5,sha1
SIGN_NOTNULL 6 _sig参数不能为空 接口调用时传入_sig参数
SIGN_WRONG 7 无效的签名，请检查参数和签名格式 _sig值根据签名算法生成
METHOD_NOTNULL 8 _mt参数不能为空 接口调用时传入_mt参数
METHOD_NOTEXIST_CODE 9 _mt对应的方法名不存在或未注册进服务 检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL 10 _requestMode参数不能为空 接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL 11 _aid参数不能为空 接口调用时传入_aid参数
APPLICATIONID_NOTSAME 12 _aid与当前key不匹配 _aid与_akey必须一一对应
VERSION_NOTNULL 13 _version版本号不能为空 接口调用时传入_version参数
TIMESTAMP_NOTNULL 14 _timestamp时间戳不能为空 接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR 15 _timestamp时间戳格式化错误 按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME 16 _timestamp已失效 _timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST 17 _format类型不存在 目前仅支持json(默认),xml
API_CALL_REPEAT -100 接口重复调用 接口平台调用异常
API_SYSTEM_CALL_ERROR -500 api调用失败，系统发生异常 接口平台调用异常
UNKNOWN_ERROR -999 开放平台系统异常 重新发起请求

业务返回码 #

返回码名称 返回码 返回码描述
code 0 seccess