# mzujie移动端 **Repository Path**: tenyu/m.mzujie ## Basic Information - **Project Name**: mzujie移动端 - **Description**: 公司移动端,新需求 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2018-01-02 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ### mzujie移动端接口文档说明 #### mzujie移动端接口 ##### http://10.0.0.10/m.mzujie/public/Api/这是公用的 ##### 用户模块在路径下加user 家具模块加fitment 订单加order ##### 返回结果样式 code状态码,messages返回数据提示信息,result返回结果,extra_img图片跟路径,颜色路径color_path ##### 系统错误码长度3 ;公共错误码长度4; 业务错误码长度6+【4位错误码+2位业务+】 ##### 接口定义状态码: | 状态 | 说明 ----------------------------------------------------------------------- | 200 | 成功请求 | 201 | 参数格式错误 | 400 | 未知错误 | 401 | 无此权限 | 500 | 服务器异常 | 506 | 参数格式 | 5000 |手机号已注册 | 5001 |字段不能为空 | 5002 |两次密码输入不一致 | 5004 |手机或者邮箱未注册 | 5005 | 密码错误 | 5006 | 密码长度不能小于六位 | 5007 |用户已被冻结 | 5008 |注册失败 | 1001 | [app_id]缺失 | 1002 | [app_id]不存在或无权限 | 1003 | [method]缺失 | 1004 | [format]错误 | 1005 | [sign_method]错误 | 1008 | [method]方法不存在 | 1010 | [nonce]缺失 | 1011 | [nonce]必须为字符串 | 1012 | [nonce]长度必须为1-32位 #### 信息校验 使用场景,注册手机短信服务,找回密码操作,更换手机号短信验证,图像验证等】【mscode】 #### 手机短信接口 ###### 参数说明: 【参数以数组方式传递,true必填,false非必填】 ###### 接口描述: 获取短信验证码 ###### 请求地址: /Api/mscode ###### 请求方式: post ###### 参数说明: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | phone | 用户手机号【mzj_frontusers表】 | true | type | @type 【1=>注册,2=>密码找回,3=>修改密码】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 | code | varchar | 验证码 #### 用户注册10 ###### 参数说明: 【参数以数组方式传递,true必填,false非必填】 ###### 接口描述: 用户注册时请求的接口 ###### 请求地址: /Api/register ###### 请求方式: post ###### 参数说明: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | phone | 用户手机号【mzj_frontusers表】 | true | email | 用户邮箱号【mzj_frontusers表】 | false | password | 密码【mzj_frontusers表】 | true | password_confirmation | 用户确认密码 | true | mscode | 验证码【存在session里面】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 | name | varchar | 用户名 | leve | varchar | 用户会员等级 #### 用户登录20 ###### 参数说明: 【参数以数组方式传递,true必填,false非必填】 ###### 接口描述: 用户登陆时请求的接口 ###### 请求地址: /Api/login ###### 请求方式: get ###### 参数说明: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | phone | 用户手机号【mzj_frontusers表】 | true(和邮箱二选一) | email | 用户邮箱号【mzj_frontusers表】 | ture(和邮箱二选一) | password | 密码【mzj_frontusers表】 | false ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 | messages | varchar | 登陆成功 | data | json | 用户数据 #### 修改邮箱 ###### 参数说明: 【参数以数组方式传递,true必填,false非必填】 ###### 接口描述: 用户修改邮箱时请求的接口 ###### 请求地址: /Api/user/SaveUserEmail ###### 请求方式: post ###### 参数说明: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | id | 用户id【mzj_frontusers表】 | true | email | 用户邮箱【mzj_frontusers表】 | true ##### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 #### 修改头像 ###### 接口描述: 用户修改头像时请求的接口 ###### 请求地址: /Api/user/SaveUserAvator ###### 请求方式: post ###### 参数说明: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | id | 用户id【mzj_frontusers表】 | true | avatar | 用户上传图片【mzj_frontusers表】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 | name | varchar | 用户名 | avator | varchar | 用户头像 #### 用户信息 ###### 接口描述: 用户查看信息时请求的接口 ###### 请求地址: /Api/user/PersonInfo ###### 请求方式: post ###### 参数描述: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | id | 用户id【mzj_frontusers表】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 | name | varchar | 用户名 | avator | varchar | 用户头像 | email | varchar | 用户邮箱 | phone | varchar | 用户手机 | leve | varchar | 会员等级 #### 修改昵称 ###### 接口描述: 用户修改昵称时请求的接口 ###### 请求地址: /Api/user/SaveUserNickName ###### 请求方式: post ###### 参数描述: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | id | 用户id【mzj_frontusers表】 | true | nickname | 用户昵称【mzj_frontusers表】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 #### 修改密码 ###### 接口描述: 用户修改密码时请求的接口 ###### 请求地址: /Api/user/SaveUserPasswd ###### 请求方式: post ###### 参数描述: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | id | 用户id【mzj_frontusers表】 | true | old_pass | 用户旧密码【mzj_frontusers表】 | true | new_pass | 用户新密码【mzj_frontusers表】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 #### 图片验证码 ###### 接口描述: 用户获取验证码时请求的接口 ###### 请求地址: /Api/user/SendCode ###### 请求方式: post ###### 参数描述: | 参数 |说明 | 备注 ---------------------------------------------------------------------------- | phone | 用户手机号【mzj_frontusers表】 | true ###### 响应数据: | 名称 | 类型 | 说明 ------------------------------- | code | number | 状态码 | SendCode | number | 验证码 #### 首页管理 ##### 首页数据 ###### 1.描述 首页数据展示 ###### 2.接口名 路径: /Api/index/index ###### 3.参数说明:(true必填,false非必填) | 参数 | 说明 | 备注 ------------------------------------------------------------------- | carsouel_number | 轮播显示数量 | false | hotfitment_number | 热门家具显示数量 | false【后台没有热门出门,目前与pc首页一致】 | bangongzhuo_number | 办公用桌子显示数量 | false | bangongyi_number | 办公用椅显示数量 | false | bangonggui_number | 办公文件柜显示数量 | false ###### 4.请求方式 get ###### 5.反馈结果 | 名称 | 类型 | 说明 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | array | 结果 ###### data 反馈结果(备注字段为需要显示或使用,其余为备用) | 字段 | 注释 ------------------------------------------------------------------------- | carsouel | 轮播图数据 (字典) | id | 轮播id | img | 轮播图片地址 | hotfitment | 热门家具(字典) |img | 图片路径 | face | 是否是封面【1是封面,0不是封面】 | bangongzhuo | 办公桌 (字典) | id | 家具详情id | fitments_name | 家具名 | fitments_describe | 家具描述 | price | 租金 | img | 图片绝对路径 | pid | 父类家具id(查看更多时需要) | bangongyi | 办公椅 同办公桌结构 | bangonggui | 办公柜 同办公桌结构 #### 家具管理 ##### 家具列表 ###### 1.描述 家具类商品展示 ###### 2.接口名 路径: /Api/fitment/list ###### 3.参数说明:(true必填,false非必填) | 参数 |说明 | 备注 -------------------------------------------------------------------------------------------------------------- | fitment_brand | 品牌id(mzj_brand表)【商家名称(自营)】 | false 【1自营(目前自由一个,默认自营)】 | fitment_type_classify | 分类id(mzj_cate表) 【办公/居家/商业】 | false【1办公,2商业,3居家,14热门】 | fitment_subcate_id | 家具子分类id(mzj_subcate表)【分类id下子分类】 | false【1=>[7=>办公桌,8=>办公椅,9=>文件柜,10=>配件],2=>[31=>办公桌,32=>办公椅],3=>[33=>办公椅子,34=>办公桌],14=>[35=>实木办公桌,36=>简约拼接桌,37=>职员办公椅]】 | fitment_price | 租赁价格 | false | minprice | 最低租金 | false | maxprice | 最高租金 | false | fitment_rent | 租赁方式 | false(1租满即送类型2随租随还类型) | fitment_orderby | 排序方式 | false(1默认排序,2升序显示,3降序显示) | fitment_name | 家具名 | false | per_page | 分页长度 | true* | current_page | 当前显示页码 | true* ###### 4.请求方式 get ###### 5.响应 | 名称 | 类型 | 说明 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | array | 结果 ###### data 反馈结果 | 字段 | 注释 ------------------------------------------------------------------------- | colors | 该家具所有的颜色统计(颜色值字段数组形式)【字符串拼接】{colors:'name1,name2'} | fitment_details_imgMaster | 家具图片路径 | price | 租金 | details_id | 家具详情id | fitments_name | 家具名 | fitments_describe | 家具描述 ##### 家具详情 【家具管理,数据反馈里面img,color_path关联的图片地址弃用,查询结果路径返回绝对路径】 ###### 1.描述 查看家具详情 ###### 2.方法名 路径: /Api/fitment/detail ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 家具详情id| true | rent_type | 租赁方式 | false ###### 4.请求方式: get ###### 5.响应结果: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | array | 结果 ###### data 反馈结果 | 字段 | 注释 ------------------------------------------------------------------------- | fitments_id | 家具id | fitments_name | 家具名 | fitments_describe | 家具描述 | fitments_contents | 家具内容信息 | details_id | 家具详情id | details_bond | 家具所需信用额度 | price | 价格显示(默认随租随还) | details_fixprice | 租满即送所需租金 | details_nimbleprice | 随租随还租金 | details_length | 当前家具详情长度尺寸 | details_width | 当前家具详情宽度尺寸 | details_height | 当前家具详情高度尺寸 | fitment_details_imgMaster | 家具组图,(img相关均为图片地址,imgMaster主图地址) | color_type | 当前选择家具详情的颜色【图片路径】 | color_types | 当前父类家具共用的所有家具颜色(已去重){colors:'name1,name2,...'} | fit_dt_sizes | 当前家具所有的尺寸型号【字符串拼接,类似【details_id,details_length,details_width,details_height,details_id,details_length,details_width,details_height】】 #### 家具分类子分类 ##### 商品分类侧边栏 ###### 1.商品分类数据 家具类名 ###### 2.方法名 /Api/fitment/cate ###### 3.请求 get ###### 4.数据反馈 | 名称 | 类型 | 备注 -------------------------------- | code | number | 状态码 | messages| string | 提示信息 | result | array | 反馈结果 ###### 5.反馈结果 | 字段 | 注释 ------------------------------------------ | id | 家具分类id | name | 家具分类名 ##### 商品分类页详情 ###### 1.描述 家具分类下子分类 ###### 2.方法名 /Api/fitment/subcate ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 家具分类id | true 支持的值(1,2,3,14)家具类型id【1办公,2商业,3居家,14热门】 ###### 4.请求: get ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages| string | 提示信息 | result | array | 反馈结果 ###### data 反馈结果 | 字段 | 注释 ------------------------------------------ | id | 子分类表id | subcate_name | 子分类名 | subcate_img | 家具子分类展示图片 #### 购物车管理 ##### 购物车列表【41】 ###### 1.描述 购物车列表查看 ###### 2.接口名 /Api/shopcar/list ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 用户id | true ###### 4.请求方式: get ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages| string | 提示信息 | result | array | 反馈结果 ###### data 反馈结果 | 字段 | 注释 ------------------------------------------ | cart_id | 购物车数据id | cart_fitment_num | 加入购物数量 | cart_rent_type | 租赁方式【1随租随还12个月,2租满即送24个月】 | price | 租金 | details_bond | 单件商品需要押金额度 | fitments_name | 家具名 | fitments_describe | 家具详情 | img | 图片路径 | color_type | 当前选择家具颜色(图片路径) | color_size | 当前家具尺寸详情【长度*宽度*高度】 ##### 购物车添加【42】 ###### 1.描述 添加购物车操作 ###### 2.方法名 /Api/shopcar/edit ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | type | 当前操作类型 | true【1=>添加】 | cart_fitment_id | 商品详情id | true | cart_fitment_num | 商品数量 | true | cart_user_id | 用户id | true | cart_rent_type | 租赁方式 | true | cart_use_time | 使用时间 | true ###### 4.请求方式: post ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages| string | 提示信息 | result | bool | 反馈结果 ##### 购物车编辑【43】 ###### 1.描述 购物车编辑操作 ###### 2.接口 /Api/shopcar/edit ###### 3.参数 | 名称 | 说明 | 备注 ---------------------------------------------------------------------------------- | id | 购物车详情id | true | type | 当前操作类型 | true【2 编辑操作】 | cart_fitment_id | 商品详情id | true【选择更换商品规格时记录】 | cart_status | 购物车选择状态 | true【0不计入结算,1计入结算】 | cart_rent_type | 租赁方式 | true | cart_fitment_num | 修改后购物车商品数量 | true ###### 4.请求方式 post ###### 5.响应 | 名称 | 类型 | 备注 ------------------------------------------------------------------ | code | number | 状态码 | messages| string | 提示信息 | result | bool | 反馈结果 ##### 购物车删除操作 ###### 1.描述 购物车删除操作 ###### 2.接口 /Api/shopcar/destroy ###### 3.参数 | 名称 | 说明 | 备注 ------------------------------------------------------- | cart_fitment_id | 要删除购物车id | true ###### 4.请求方式 get ###### 5.响应 | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | msg | string | 提示信息 | data | bool | 反馈结果 #### 订单管理 ##### 我的订单 ###### 1.描述 用户查看订单时请求 ###### 2.接口名 /Api/order/orderList ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 用户id | true ###### 4.请求方式: post ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | msg | string | 提示信息 | data | array | 反馈结果 ##### 已完成订单 ###### 1.描述 用户已经签收的订单 ###### 2.接口名 /Api/order/end_orderList ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 用户id | true ###### 4.请求方式: post ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | msg | string | 提示信息 | data | array | 反馈结果 ##### 已支付订单 ###### 1.描述 用户已经付钱的订单 ###### 2.接口名 /Api/order/pay_orderList ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 用户id | true ###### 4.请求方式: post ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | msg | string | 提示信息 | data | array | 反馈结果 ##### 未支付订单 ###### 1.描述 用户还没付钱的订单 ###### 2.接口名 /Api/order/notPay_orderList ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | id | 用户id | true ###### 4.请求方式: post ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | msg | string | 提示信息 | data | array | 反馈结果 ##### 订单详情 ###### 1.描述 用户查看订单详情时请求 ###### 2.接口名 /Api/order/DetailList ###### 3.参数: | 名称 | 说明 | 备注 ------------------------------------------------------ | order_id | 订单id | true ###### 4.请求方式: post ###### 5.响应: | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | msg | string | 提示信息 | data | array | 反馈结果 #### 账单管理 #### 文件管理 ##### 文件上传(接口处理,暂时不要,修改校验) ###### 1.描述 文件上传管理 ###### 2.接口名 /Api/file/upload ###### 3.参数: | 名称 | 说明 | 备注 ----------------------------------------------------- | path | 上传的路径 | true({avatar(用户头像);quota_img(申请额度文件);repair_img(售后图片)}) | file | 上传文件 | true(上传文件页面的字段名) ###### 4.请求方式: post ###### 5.响应 | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | array | true ###### data数据反馈 | 字段 | 注释 -------------------------------------- | upload | 上传结果状态(bool类型,true成功,false上传失败) | info | 上传文件信息,【upload为false,这里为文件信息反馈】 | filename | 上传保存文件名(upload为true时) | path | 文件保持路径(upload为true时) #### 新闻类栏目管理(暂无) #### 增值服务 ##### 室内设计 ###### 1.描述 记录用户室内设计需求 ###### 2.方法名 /Api/extra/interior ###### 3.请求参数 | 名称 | 说明 | 备注 ----------------------------------------------------- | userid | 当前用户id | true | design_name | 装修类别 | true 【工装/家装】 | design_type | 风格类型 | true | design_space | 空间面积 | true | design_amount | 预算报价(元) | true | design_require | 设计需求描述 | false ###### 4.请求方式 post ###### 5.响应 | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | number | 返回记录数据id,大于0成功 ##### 定定制化产品 ###### 1.描述 记录用户特殊需求产品 ###### 2.方法名 /Api/extra/customized ###### 3.请求参数 | 名称 | 说明 | 备注 ----------------------------------------------------- | userid | 当前用户id | true | customized_size | 产品尺寸 | true | customized_color | 产品颜色 | true | customized_num | 定制数量 | true | customized_use | 用途 | true | customized_require | 具体需求 | false ###### 4.请求方式 post ###### 5.响应 | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | number | 返回记录数据id,大于0成功 ##### 搬家服务 ###### 1.描述 搬家服务记录 ###### 2.方法名 /Api/extra/moveservice ###### 3.请求参数 | 名称 | 说明 | 备注 ------------------------------------------------------- | userid | 当前用户id | true | move_name | 联系人姓名 | true | move_phone | 联系电话 | true | move_email | 联系邮箱 | true | move_addr | 搬家地址 | true | move_require | 搬家具体需求 | false ###### 4.请求方式 post ###### 5.响应 | 名称 | 类型 | 备注 ------------------------------------------------------ | code | number | 状态码 | messages | string | 提示信息 | result | number | 返回记录数据id,大于0插入成功