@xuduochoua 2018-11-07T00:36:30.000000Z 字数 29242 阅读 1467

聚来宝

private

聚来宝
一、通用说明
二、接口文档
----------------------------------------------------
省惠优选二期

一、通用说明

1 `一般通用返回JSON格式说明`

{
    code:0,//返回码 0-默认  成功
    msg:"",//错误码说明信息
    data:null//接口需求的具体数据 或List 或String 等
}

2 `一般返回的列表数据格式说明`

 {
    code:0,//返回码 0-默认  成功
    msg:"",//错误码说明信息
    data:{//接口需求的具体数据 或List 或String 等
        "total": 2,//总数量
        "size": 10,//每一页的数量
        "page": 1,//当前页码
        "pages": 1,//总页数
        "curSize": 2,//当前页的数量
        "datas"[//数据列表
        ]
    }
}

3 `关于文件上传的一些说明`

- 所有的文件均为异步上传，上传完毕，返回附件id，作为参数使用，
- 参数为单文件的时候直接使用id，参数为多文件的时候，多文件id用英文逗号拼接(如1,2,3)；
- 一般情况下后台返回的包含附件数据如下简单说明：
    > 如单附件 字段为xx ，则同时会转义xxUrl 作为真实访问地址，
        多附件字段为xxs,则转化为xxUrls数组作为多真实url

-如
{ "id":1,//某个数据的id "name"："someone", "icon"：2,//单附件id "iconUrl"："http://www.xxx.com/xxx/2",//附件url "images":"3,5,4",//多附件ids "imageUrls":[//多附件url数组 "http://www.xxx.com/xxx/3","http://www.xxx.com/xxx/5","http://www.xxx.com/xxx/4" ] }

- 文件上传请求如下

请求地址
POST http://112.74.200.84/ajax/upfile
请求参数:

参数	数据类型	必填	参数说明
upfile	file	Y	上传的文件
module	int	N	所属模块如 1 ，2， 3

module说明
暂含： 1-头像 2评论

响应结果:

{
   "code": 0,//成功为0  ，503=未知错误 204= 没有上传文件(空文件)
   "message":"",//失败时候的说明
   "id":5,//附件id
   "value": "/files/upload/2017/11/21/1.jpg-37904136-5868-4283-a3be-baf05576b30c/1.jpg",//附件本项目中的地址 暂不使用
   "url": "http://39.106.13.51:10081/attachment/ajax/visit/5",//附件的访问地址
   "fileName": "1.jpg",//文件名
   "size": 3349//文件大小
}

4 `base_url`

......

5 安全

  · 对所有请求参数转json后进行AES统一加密，加密key为....，请求参数为`param`
    · 对所用返回数据进行AES统一加密，加密key为....
    测试联调阶段不转json,不加密(就是普通的http请求，不对参数做额外处理)；
    另后续会考虑引入JWT（JSON WEB TOKEN）

6 通用错误码说明

code	说明
401	未登录
400	请求参数错误
500	意料之外的错误，未处理的错误
701	当前账户已在其他手机登陆，您已被迫下线，请重新登陆

7 推送说明

使用的为极光推送
登录的时候传入设备号，见登录接口

8 单手机登录说明

登录的时候会返回当前登录设备的token，在其他需要登录的接口的header中加入参数token，token值即为此值。

二、接口文档

1 登录注册

1.01 发送短信验证码

接口地址:
GET /auth/smscode
请求参数:

参数	数据类型	必填	参数说明
mobile	string		接收短信的手机号码

错误码说明

code	错误原因	返回消息
702	发送短信验证码失败	发送短信验证码失败

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": 123456
}

1.02 注册账号

接口地址:
POST /auth/register
请求参数:

参数	数据类型	参数说明
mobile	string	手机号
smscode	string	验证码
password	String	密码
recommendCode	String	邀请码

错误码说明

code	错误原因	返回消息
703	短信验证码错误	无效的短信验证码
801	手机号已经注册	当前手机号已经注册

响应结果:
参见：登录

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": {}//参见用户登录
}

1.03 手机号登陆

接口地址:
POST /auth/login
请求参数:

参数	数据类型	参数说明
mobile	string	手机号
password	string	密码
mobileCode	String	手机设备号用于极光推送

错误码说明

code	错误原因	返回消息
802	不存在的用户	不存在的用户
803	用户被禁用	用户被禁用
804	密码错误	密码错误

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "id": 1,
        "mobile": "15012345678",
        "nickname": "张三",
        "gender": 1,//1-男 2-女 0-保密
        "birthday": "2000-12-12",//生日
        "headpic": 1,//头像地址  在附件表中的id
        "headpicUrl": "http://xxx",//头像的真正地址
        "thirdPartyType": 1,//第三方登陆方式 1-微信 2-qq 3-支付宝 当前只有微信
        "thirdPartyUid": "456asd",//第三方登陆id
        "thirdPartyHeadpic": "http://....",//第三方登陆头像url
        "recommendQcodePath": 1,//我的推荐二维码 图片对应附件表的id
        "recommendQcodePathUrl": "http://....",//我的推荐二维码url 图
        "recommendUrl": "http://xxx",//我的推荐地址  对应我的推荐二维码中存储的地址
        "recommendId": 1,//我的推荐人id
        "recommendPid": 2,//我的推荐人的推荐人id
        "recommendFid": 0,//我的推荐人的推荐人的推荐人的id
        "enabled": false,//是否可用
        "score": 150,//我的积分
        "mobileCode": "",//对应极光推送的设备码
        "recommendCode": "xxa4s5asdaolkj",//我的邀请码
        "viped": 1,// 是否是vip会员 0-false 1-true
        "createTime": "2018-04-12 12:12",//注册时间
        "aliAccount": null,//绑定的支付宝账号
        "wechatAccount": null,//绑定的微信账号
        "taobaoAccount": null,//绑定的淘宝账号
        "token": "xxxxxxasdads"//登录时候返回的token 用于单设备号登录
    }
}

1.04 手机验证码登录

接口地址:
POST /auth/smscodeLogin
请求参数:

参数	数据类型	参数说明
mobile	string	手机号
smscode	string	验证码
mobileCode	String	手机设备号用于极光推送

错误码说明

code	错误原因	返回消息
703	短信验证码错误	无效的短信验证码
802	不存在的用户	不存在的用户
803	用户被禁用	用户被禁用

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {// 见1.03账号密码登陆
    }
}

1.05 微信登陆-第三方登陆

此处后台不做第三方账号校验，即不根据token去第三方获取用户信息了，而是直接app前端传递用户第三方账号信息给后台；另本项目只做微信登录，此处为预留其他登录方式

POST /auth/thirdLogin
请求参数:

参数	数据类型	参数说明
thirdPartyType	int	第三方登陆方式 1-微信 2-qq 3-支付宝默认 1
thirdPartyUid	String	第三方用户唯一标识
nickname	String	昵称
thirdPartyHeadpic	String	头像URL地址

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {}//同登录用户信息
}

1.06 忘记密码

POST /auth/forget

请求参数:

参数	数据类型	参数说明
mobile	String	手机号
smscode	String	验证码
password	String	新密码

错误码说明

code	错误原因	返回消息
703	短信验证码错误	无效的短信验证码
802	不存在的用户	不存在的用户

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {}//用户信息
}

1.07 修改密码

POST /auth/updatePassword
请求参数:

参数	数据类型	参数说明
mobile	String	手机号
oldPassword	String	原密码
newPassword	String	新密码

错误码说明

code	错误原因	返回消息
804	密码错误	密码错误
802	不存在的用户	不存在的用户

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

1.08 退出登录

POST /auth/logout
请求参数:

参数	数据类型	必填	参数说明
userId	int		用户id

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

1.09 绑定手机号

POST /auth/bindPhone
请求参数:

参数	数据类型	参数说明
userId	int	用户id
smscode	string	验证码
mobile	String	用户id

错误码说明

code	错误原因	返回消息
701	当前用户已绑定手机号	当前用户已绑定手机号，请勿重复绑定
801	当前手机号已被使用	当前手机号已注册

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

2 全局配置

2.01 启动页列表

接口地址:
GET /system/bootPages

请求参数:

参数	数据类型	必填	参数说明
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": [{
            "id":1,
            "imageUrl":"http://39.106.13.51:10081/attachment/ajax/visit/1",//图片地址
            "title"："我是文字说明"
        }
        ,...
    ]
}

2.02轮播图列表

接口地址:
GET /system/banners

请求参数:

参数	数据类型	必填	参数说明
type	int	N	类型 1-首页banner 2-9.9专场

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": [{
            "id": 1,
            "image": 1,//图片所属附件id
            "imageUrl": "http://39.106.13.51:10081/attachment/ajax/visit/1",
            "target": "www.baidu.com",//跳转目标。url_type=1 则为页面url，2则为特色分类id
            "title": "去百度",
            "type": 1,
            "urlType": 2 // 跳转方式 1-页面url，2-特色分类列表
        },...
    ]
}

2.03关于我们

接口地址:
GET /system/aboutus

请求参数:

参数	数据类型	必填	参数说明

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": ".....内容详情...."
}

2.04 版本更新

获取当前APP的最新版本信息前端比对决定是否升级更新

接口地址:
POST /system/version

请求参数:

参数	数据类型	必填	参数说明
machineType	int		1-安卓 2-IOS

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": {
        "id":1,
        "name":"xx版本",  //版本名称
        "version":"1.1.1",//版本
        "number":2,//版本数字编号，高版本始终大于低版本
        "machineType":1,//1-安卓 2-ios
        "log":"本次更新的更新说明....",//更新说明
        "downloadUrl":"url"//下载地址 ios应指向苹果商店，安卓则为本项目中的下载地址
    }
}

2.05 客服电话

接口地址:
POST /system/contact

请求参数:

参数	数据类型	必填	参数说明
无

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": "15088886666"//联系电话
}

2.06 商品分类

GET /system/commodityCategories

请求参数:

参数	数据类型	必填	参数说明
page	int		分页参数
size	int		分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "name":"分类名称",//分类名称
                "icon":1,
                "iconUrl": "http://39.106.13.51:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

2.07 特色商品分类列表

GET /system/commoditySpecialCategories

请求参数:

参数	数据类型	必填	参数说明
page	int		分页参数
size	int		分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "name":"分类名称",//特色分类名称
                "title":"分类简述",//分类简述
                "icon":2,
                "iconUrl": "http://39.106.13.51:10081/attachment/ajax/visit/2"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

2.08 提现须知

接口地址:
GET /system/fetchNotice

请求参数:

参数	数据类型	必填	参数说明

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": ".....内容详情...."
}

3 个人中心

3.01 获取用户信息

GET /personal/userInfo
请求参数:

参数	数据类型	必填	参数说明
userId	int		用户id

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {}//同登录返回的用户信息
}

3.02 编辑个人信息

POST /personal/edit
请求参数:

参数	数据类型	参数说明
id	int	用户id
headpic	int	头像附件id
nickname	String	昵称
gender	int	性别 0-保密 1-男 2-女
birthday	Date	生日 yyyy-MM-dd格式的日期字符串

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {}//用户详情 参见登陆
}

3.03 绑定第三方账户-第三方授权?

POST /personal/edit
请求参数:

参数	数据类型	参数说明
id	int	用户id
aliAccount	String	支付宝账号
wechatAccount	String	微信账号
taobaoAccount	String	淘宝账号

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {}//用户详情 参见登陆
}

3.04 我的收藏列表

GET /personal/collections

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "currentId":1,//收藏表的id
                "id": 3,//商品id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.05 新增/取消收藏> 没有收藏则新增有收藏则删除

POST /personal/collection/add
请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
type	int	收藏的类型 1-商品 (暂时只有商品 )
targetId	int	收藏的目标id 暂时均为商品id

错误码说明

code	错误原因	返回消息
无

响应结果:

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

3.06 删除收藏

POST /personal/collection/{id}/delete
路径参数
id 收藏记录的id
请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

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

3.07 最近浏览

GET /personal/visitList

只保留最多最新的20条浏览记录

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "currentId":1,//浏览记录表的id
                "id": 3,//商品id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.08 删除最近浏览

POST /personal/visit/{id}/delete
路径参数
id 收藏记录的id
请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

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

3.08 消息通知列表

GET /personal/msgs

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
role	int	1-个人消息 2-系统信息
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "customerId": 1,
                "role": 1,1-个人消息 2-系统信息  
                "content": "消息内容",
                "createTime": "2017-12-12",
                "readed": 0,//0-未读 1-已读
                "type": 2,// 1-个人消息 2-系统信息  
                "msgId": 1
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.09 消息详情(置为已读)

GET /personal/msg/{id}

路径参数
id 消息id

请求参数:

参数	数据类型	必填	参数说明
无

响应结果:

{
    "code": 0,
    "msg": "",
    "data":   
        {
            "id": 1,
            "customerId": 1,
            "role": 1,//1-用户 2-商户
            "content": "消息内容",
            "createTime": "2017-12-12",
            "readed": 0,//0-未读 1-已读
            "type": 2,// 1-个人消息 2-系统信息  
            "isDelete": 0,
            "msgId": 1
        }
}

3.10 删除消息

POST /personal/msg/{id}/delete

路径参数
id 消息id

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

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

3.11 会员奖励总额

GET /personal/reward

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

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

3.12 会员奖励列表

GET /personal/rewards

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "customerId": 1,
                "money": 9.9,//金额 
                "describe": "简单说明",
                "createTime": "2017-12-12 12:12"
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.13 会员福利概览

GET /personal/welfare

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "balance":99.99,//当前福利余额
        "totalBalance":100.00,//历史总福利余额
        "goingBalance":21.01//在路上的福利
    }
}

3.14 会员福利列表

GET /personal/welfares

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "customerId": 1,
                "money": 9.9,//金额 
                "detail": "简单说明",
                "createTime": "2017-12-12 12:12",
                "modifyTime":"2018-12-12 12:12"//转入时间
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.15我的钱包余额

GET /personal/balance

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

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

3.15-1我的钱包概览

GET /personal/balanceSurvey

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "balance"：10.08,//当前余额
        "totalBalance"：20.08,//历史总余额
        "fetchMoney"：10.00// 已提现余额(= 总 - 当前)
    }
}

3.16账单明细-余额明细

GET /personal/balances

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
status	int	类别 1-收入 2-提现；不传或传0 为全部
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "customerId": 1,
                "money": 8.9,//金额 
                "describe": "简单说明",
                "createTime": "2018-12-12 12:12"
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.17 提现申请

POST /personal/fetch

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID
money	double		提现金额单位元， 2位小数；最小金额为0.1元

错误码说明

code	错误原因	返回消息
802	不存在的用户	不存在的用户
815	余额不足	余额不足
816	当前账号未绑定支付宝账号	当前账号未绑定支付宝账号
817	提现失败	提现失败

响应结果:

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

3.18 升级VIP说明

GET /personal/vipExplain

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  "图文说明富文本"
}

3.19升级VIP

拼接支付的一些信息主要是金额和单号

POST /personal/upgradeVip

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID
payType	int		支付方式 1-支付宝 2-微信

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "id": 1,//id
        "payNo": "20156465313456",//支付单号
        "payType": 1,//支付方式 1-支付宝 2-微信
        "amount": 99.00,//金额
        "createTime": "2018-05-15 12:11",
        "customerId": 1//用户id
    }
}

3.20我的团队概览

GET /personal/recommendTeam

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "mineRecommend": "zhangsan",//我的推荐人
        "directViped": 10,//直接会员 人数
        "indirectViped":9,//间接会员 人数
        "directUnviped":22,//直接普通 人数
        "indirectUnviped":15//间接普通 人数
    }
}

3.21我的团队列表

GET /personal/recommendTeams

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
type	int	1- 会员 0-普通
role	int	role 1-直接 0-间接
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,//用户id
                "viped": 1,//是否vip
                "mobile": "15012341234",//电话 
                "nickname": "张三",//昵称
                "headpicUrl": "http://....",//头像
                "createTime":"2018-12-12 12:12"
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.22宣传物料

GET /personal/adteams

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,//用户id
                "title": "闻君有两意，故来相决绝",//title
                "images": ["",""],//图片数组
                "createTime": "2018-05-12"//创建时间
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.23 晒晒成绩

POST /personal/harvest

请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
image	int	图片的附件id
content	int	内容

响应结果:

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

3.24 消费积分概览

GET /personal/score

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "convertedAmount": 5.5,//累计转换金额
        "currentScore":105,//当前积分
        "goingScore":201//在路上的积分
    }
}

3.25 消费积分明细

GET /personal/scores

请求参数:

参数	数据类型	参数说明
userId	int	用户ID
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 1,
                "customerId": 1,
                "score": 50,//积分
                "createTime": "2018-05-25 12:12:12",//时间
                "type": 1,//类型  1-消费获得积分 2-积分转入余额
                "describe":"积分转入余额"
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.26 积分转换

100分 == 0.5元，只转100的整数倍，少于100不转入（如120积分等于转0.5元剩余20积分），虽然后端会判断，但请前端在积分少于100的时候按钮置灰

POST /personal/convertScore

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

错误码说明

code	错误原因	返回消息
1101	积分不满100	积分不足

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {}//同积分概览
}

3.27 概览统计会员奖励 | 消费积分 | 会员福利 | 我的钱包

GET /personal/overview

路径参数
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		用户ID

响应结果:

{
    "code": 0,
    "msg": "",
    "data":  {
        "reward": 5.5,//会员奖励
        "welfare":10.5,//会员福利
        "score":201,//积分
        "balance":52.05 //钱包
    }
}

4 商品相关

4.01 必买清单商品列表

GET /commodity/needBuyedList

请求参数:

参数	数据类型	必填	参数说明
page	int		分页参数
size	int		分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.02 分类商品列表 || 系统内搜券

GET /commodity/commodityList

请求参数:

参数	数据类型	参数说明
categoryId	int	分类id 查询分类列表时必传，搜券时选填
keywords	String	搜券时候传入的关键字
type	int	宝贝类型 1-淘宝 2-天猫不传则为全部
sortType	int	排序字段 1销量 2- 最新 3-券额 4-券后价默认1
orderType	int	排序方式 1-升序 2-降序默认1
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.03 特色分类商品列表.

GET /commodity/specialCommodityList

请求参数:

参数	数据类型	参数说明
specialCategoryId	int	特色分类id
categoryId	int	分类id
type	int	宝贝类型 1-淘宝 2-天猫不传则为全部
sortType	int	排序字段 1销量 2- 最新 3-券额 4-券后价默认1
orderType	int	排序方式 1-升序 2-降序默认1
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.04 9.9专场商品列表

GET /commodity/nineCommodityList

请求参数:

参数	数据类型	必填	参数说明
page	int		分页参数
size	int		分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.05 今日推荐商品列表

GET /commodity/todayRecommendedCommodityList

请求参数:

参数	数据类型	参数说明
categoryId	int	分类id
type	int	宝贝类型 1-淘宝 2-天猫不传则为全部
sortType	int	排序字段 1销量 2- 最新 3-券额 4-券后价默认1
orderType	int	排序方式 1-升序 2-降序默认1
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.06 品牌商家列表

每个品牌商家下默认包含9个商品不足9 则显示实际的数量

GET /commodity/brandSellerList

请求参数:

参数	数据类型	必填	参数说明
page	int		分页参数
size	int		分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
            "id": 1,
            "name": "李宁",
            "commodityList": [//此品牌下的商品列表
                    {
                    "id": 1,
                    "name": "11",
                    "type": 1,
                    "price": 20.00,
                    "discountPrice": 48.00,
                    "sellNum": 12,
                    "couponAmount": 10.00,
                    "iconUrl": "http://112.74.200.84:10081/attachment/ajax/visit/1"
                    }
                ]
            },
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.07 品牌专区商品列表.

GET /commodity/brandCommodityList

请求参数:

参数	数据类型	参数说明
brandSellerId	int	品牌商家id
sortType	int	排序字段 1销量 2- 最新 3-券额 4-券后价默认1
orderType	int	排序方式 1-升序 2-降序默认1
page	int	分页参数
size	int	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1"//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.08 商品详情

GET /commodity/detail/{id}
路径参数:
id : 商品id

请求参数:

参数	数据类型	必填	参数说明
userId	int		当前用户id

响应结果:

{
    "code": 0,
    "msg": "",
    "data":{
        "id": 1,
        "itemId":"123456",//淘宝商品id
        "name": "11",
        "type": 1,
        "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1",//图标
        "imageUrls": [ //图片列表
        "http://112.74.200.84:10081/attachment/ajax/visit/1"
        ],
        "price": 20.00, //原价
        "discountPrice": 48.00, //券后价
        "sellNum": 12,//销量
        "categoryId": 1,//分类id
        "couponStartDate": "2018-04-27 12:20",//折扣开始时间
        "couponEndDate": "2018-05-03 12:20", //折扣结束时间
        "couponAmount": 10.00,//折扣额
        "mineCommision":2.05,//预估佣金
        "couponUrl": "www.baidu.com",//跳转地址
        "summary": "asdasdasd",//简介
        "content": "asdasdasdasd",//图文详情
        "collected":false,//当前用户是否收藏此商品
        "freeShip": 1,//是否包邮 1-是 0-否
        "taoToken": "xxxxxx",//淘口令
        "createTime": "2018-04-27 12:20"//新建时间
    }
}

4.09 获得针对此用户的推荐链接

GET /commodity/clickUrl
路径参数:
无

请求参数:

参数	数据类型	必填	参数说明
userId	int		当前用户id
itemId	int		淘宝商品id，见商品列表和详情的itemId和4.10、 4.11中的淘宝商品id

错误码说明

code	错误原因	返回消息
802	不存在的用户	不存在的用户
821	用户未绑定淘客推广位	用户未绑定淘客推广位，请联系管理员
822	不存在的商品	不存在的商品
823	获取转链失败	获取转链失败，请联系管理员

响应结果:

{
    "code": 0,
    "msg": "",
    "data":"https://....." //推荐链接
}

4.10 搜索淘宝客商品

每次固定返回30条数据；返回的数据为淘宝客接口的数据

GET /commodity/tbkSearch

路径参数:
无

请求参数:

参数	数据类型	必填	参数说明
keyword	String		搜索的关键词
pageNum	int		页码默认1

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,
    "msg": "",
    "data":[{
        "itemId": "16546132",//淘宝商品id
        "title": "啊实打实大苏打",//标题
        "currentPrice": 120.20,//当前价格
        "couponPrice": 5.0,//优惠券价格
        "afterCouponPrice": 115.20,//券后价
        "biz30Day": 5001,//可能是月销量吧
        "clickUrl": "",//淘客url
        "shareUrl": "",//分享url地址?
        "pictUrl": "",//图标地址
        "userType": 0,//卖家类型，0表示集市，1表示商城
        "sendCouponCount": 1000,//已发出的优惠券
        "totalCouponCount": 5000//总优惠券数量
    }]
}

4.11 淘宝客商品详情

针对4.10搜索出的商品前往淘宝查询详情信息

GET /commodity/tbkDetail

路径参数:
无

请求参数:

参数	数据类型	必填	参数说明
itemId	String		淘宝商品id

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,
    "msg": "",
    "data":{
        "catLeafName": "",//叶子类目名称
        "catName": "",//一级类目名称
        "clickUrl": "",//淘客地址
        "commissionRate": "",//佣金比例
        "couponAmount": "",//优惠后价格？
        "couponPrice": "",//优惠券额度
        "couponStartFee": "",//优惠券使用门槛金额
        "itemUrl": "",//商品地址
        "nick": "",//卖家昵称
        "numIid": "",//商品ID
        "pictUrl": "",//商品主图
        "provcity": "",//宝贝所在地
        "reservePrice": "",// 商品一口价格
        "sellerId": "",//卖家id
        "shopTitle": "",//店铺名称？
        "smallImages": ["",""],//商品小图列表
        "title": "",//商品标题
        "tkRate": "",//佣金比例？
        "userType": 0,//卖家类型，0表示集市，1表示商城
        "volume": 5461,//30天销量
        "zkFinalPrice": "",//商品折扣价格
        "zkFinalPriceWap": ""//不知啥意思
    }
}

5 其他

5.1 支付宝回调地址

GET || POST /callback/alipay

5.2 微信回调地址

POST /callback/wxpay

----------------------------------------------------

省惠优选二期

对原来商品模块进行调整，主要为分类升级为二级分类；且特色商品分类和商品的关系调整为一一对应；另外新增商品模块分类入口（爱生活和品牌精选），且模块分类下也包含二级分类；商品列表与详情尽量保持与一期一致，可能会新增部分字段；移除原来的9.9专场、品牌商家，皆变为特色商品分类；原来的今日推荐改为进口优选;
模块新增主要包括：省惠快报、金豆相关(签到、兑换)、拼团、个人中心新加`收货地址与会员排行耪；
其他，在线客服（socket）;轮播图9.9专场改为省惠快报类型

1商品相关

1.01-商品分类（一级/二级/热卖）

接口地址:
GET /commodity/categories
请求参数:

参数	数据类型	必填	参数说明
pid	Integer		分类id，不传则为查询一级分类，传PID 则为此分类下的热门分类和子分类

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": [//返回都均为数组，传pid的时候返回的数组长度为1，即置为当前分类的子分类和热门分类
        {
            "id": 1,//分类id
            "pid": null,//所属分类id
            "name": "",//name
            "iconUrl": "",//图标地址
            "subCategories": [//当查询的为全部一级分类的时候，第一个分类下会查询出自分类
                    {
                        "id": 2,//分类id
                        "pid": 1,//所属分类id
                        "name": "",//name
                        "iconUrl": ""//图标地址
                    }
                ],
            "hotCategories": [////当查询的为全部一级分类的时候，第一个分类下会查询出子热门分类
                {
                        "id": 3,//分类id
                        "pid": 1,//所属分类id
                        "name": "",//name
                        "iconUrl": ""//图标地址
                }
            ]
        }
    ]
}

1.02-模块商品分类（爱生活/品牌精选）

接口地址:
GET /commodity/moduleCategories
请求参数:

参数	数据类型	必填	参数说明
module	Integer	no	默认1， 1-爱生活 2-品牌精选

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
        "data": [{
            "id": 1,
            "name": "分类1",
            "title": "简单说明",
            "module": 1,//1-爱生活 2-品牌精选
            "iconUrl": ""//图标地址
        }]
}

1.03-商品列表（普通商品列表-特色商品列表-模块商品-今日推荐-进口优选）

见分类商品列表返回数据一致

GET /commodity/commodities

请求参数:

参数	数据类型	必填	参数说明
categoryId	int	N	一级分类id 查询分类列表时必传，搜券时选填
subCategoryId	int	N	二级分类id
specialCategoryId	int	N	特色分类id
module	int	N	模块 1-爱生活 2-品牌精选
moduleCategoryId	int	N	模块分类id
imported	int	N	是否进口优选 1-是 0-否
needBuyed	int	N	是否必买清单 1-是 0-否
keywords	String	N	搜券时候传入的关键字
type	int	N	宝贝类型 1-淘宝 2-天猫不传则为全部
sortType	int	N	排序字段 1销量 2- 最新 3-券额 4-券后价默认1
orderType	int	N	排序方式 1-升序 2-降序默认1
page	int	N	分页参数
size	int	N	分页参数

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 3,//id
                "itemId":"123456",//淘宝商品id
                "name": "22",//名称
                "type": 1,//宝贝类型，1-淘宝 2-天猫
                "price": 20.00,//原价
                "discountPrice": 49.00, //折扣后价格
                "sellNum": 11,//销量
                "couponAmount": 10.00,//优惠券金额
                "mineCommision":2.05,//预估佣金
                "iconUrl":"http://112.74.200.84:10081/attachment/ajax/visit/1",//图标地址
                "videoUrl":"http://112.74.200.84:10081/attachment/ajax/visit/xx.mp4"//视频地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

2省惠快报

2.01快报列表

接口地址:
GET `/news/articles
请求参数:

参数	数据类型	必填	参数说明
page	int	X	分页参数
size	int	X	分页参数

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data":{
        "datas": [
            {
                "id": 1,
                "title": "静夜思",
                "author": "李白",
                "summary": "李白的诗",//简介
                "createTime": "",//创建时间
                "praiseNum": 1,//点赞数
                "viewNum": 2,//浏览数
                "iconUrl": ""//图标地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

2.02快报详情

接口地址:
GET /news/article/{id}

路径参数

id ： 快报id

请求参数:

参数	数据类型	必填	参数说明
userId	Integer	X	用户id

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": {
        "id": 1,
        "title": "",
        "author": "",
        "summary": "",
        "content": "",//图文详情 富文本
        "createTime": "",
        "praiseNum": 1,
        "viewNum": 2,
        "praised": true,//当前用户是否已点赞
        "iconUrl": ""
    }
}

2.03点赞/取消点赞

已经点赞则取消点赞，未点赞则点赞

接口地址:
POST /news/article/praise
请求参数:

参数	数据类型	必填	参数说明
id	int	Y	快报id
userId	int	Y	用户id

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": null
}

3 拼团

3.01拼团列表

接口地址:
GET /group/groupList
请求参数:

参数	数据类型	必填	参数说明
page	int	N	分页参数
size	int	N	分页参数

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": {
        "datas": [
            {
                "id": 1,
                "name": "mingc",
                "price": 5.6,//原价格
                "groupPrice": 0,//拼团价格，前端写死 0元
                "stock": 10,//库存
                "groupNum": 10,//已拼数
                "labels": "xx,yy,zz",//标签 英文逗号分隔
                "content": "图文详情",//详情页用到此字段
                "targetNum": 10,//完成此拼团需要邀请的人数
                 "createTime": "",//创建时间
                "canOpen": true,//当前用户是否可开启此拼团 也是详情页面使用此字段
                "custList": [//开启此拼团的人 的列表
                    {
                        "name":"张三",
                        "headpicUrl":"头像地址",
                        "startDate":"2018-12-12 12:12:12",//开启拼团的时间
                        "startDateDesc":"45分钟前"//开启拼团的时间的描述
                    }
                ],
                "iconUrl": "图标url",
                "imagesUrls": ["",""]//图标数组
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

3.02 拼团详情

接口地址:
GET /group/group/{id}

路径参数

id:拼团id

请求参数:

参数	数据类型	必填	参数说明
userId	Integer	N	用户id

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data":  {
                "id": 1,
                "name": "mingc",
                "price": 5.6,//原价格
                "groupPrice": 0,//拼团价格，前端写死 0元
                "stock": 10,//库存
                "groupNum": 10,//已拼数
                "labels": "xx,yy,zz",//标签 英文逗号分隔
                "content": "图文详情",//详情页用到此字段
                "targetNum": 10,//完成此拼团需要邀请的人数
                 "createTime": "",//创建时间
                "canOpen": true,//当前用户是否可开启此拼团 也是详情页面使用此字段
                 "customerGroup": {//如果当前用户已经开启了此拼团 则显示此数据(拼团订单)
                        "id": 2,//订单id
                        "groupId": 1,//所属拼团id
                        "customerId": 2,//此用户id
                        "targetNum": 10,//目标人数
                        "inviteNum": 8,//已经邀请的人数
                        "status": null,//状态 0-初始 1-完成 2-失败 3-取消
                        "createTime": "",//拼团开始时间
                        "endTime": "2018-12-12 12:12:12",//结束时间
                            "custList": [//已经邀请的人的列表
                                {
                                    "name":"张三",
                                    "headpicUrl":"头像地址" 
                                }
                            ],
                        "residueSecond": 3600//离结束还有多少秒 前端也可根据 endTime 自己计算
                },
                "iconUrl": "图标url",
                "imagesUrls": ["",""]//图标数组
       }
}

3.03开启拼团

接口地址:
POST /group/open
请求参数:

参数	数据类型	必填	参数说明
groupId	int	Y	拼团id
userId	int	Y	用户id
addressId	int	Y	收货地址

错误码说明

code	错误原因	返回消息
2001	今天已经开启过团购	今天已经开启过团购
2002	不存在的拼团	不存在的拼团
2003	库存不足	库存不足
802	用户不存在	用户不存在
2004	非VIP用户,不可开启	非VIP用户

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data":  {
                     "id": 2,//订单id
                        "groupId": 1,//所属拼团id
                        "customerId": 2,//此用户id
                        "targetNum": 10,//目标人数
                        "inviteNum": 8,//已经邀请的人数
                        "status": null,//状态 0-初始 1-完成 2-失败 3-取消
                        "createTime": "",//拼团开始时间
                        "endTime": "2018-12-12 12:12:12",//结束时间
                            "custList": [//已经邀请的人的列表
                                {
                                    "name":"张三",
                                    "headpicUrl":"头像地址" 
                                }
                            ],
                        "residueSecond": 3600//离结束还有多少秒 前端也可根据 endTime 自己计算
                }
}

3.04我的拼团订单

接口地址:
GET /group/groupOrders
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
page	int	N	分页参数
size	int	N	分页参数

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": {
        "datas": [
            {
               "id": 2,//拼团订单id
                "groupName": "拼团的名称",
                "iconUrl": "图标地址",
                "createTime": "",//拼团时间
                "status": 1//状态 0-初始 1-完成 2-失败 3-取消
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4金豆

4.01签到概览(金豆 + 连续签到天数)

接口地址:
GET /sign/survey
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
        "data": {
            "id": 1,
            "customerId": 2,
            "socre": 100,//金豆数量
            "continuousDay": 2,//连续签到的天数
            "lastSignDate": "2018-12-12",//最后签到日期
            "continuousStartDate": "2018-12-11"//连续签到的起始日期
        }
}

4.02某月签到天数列表

接口地址:
GET /sign/signins
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
date	Date	N	月份yyyy-MM 如2018-07

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
        "data": [
            {
                "id":1,
                "socre":2,//签到获得的金豆
                "createTime":"2018-12-12:12:12:12"//签到时间
            }
        ]
}

4.03签到

接口地址:
POST /sign/signin
请求参数:

参数	数据类型	必填	参数说明
userId	Integer	Y	用户id

错误码说明

code	错误原因	返回消息
901	重复签到	已经签到，请不要重复签到

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": 2//获得的积分
}

4.04 商品兑换列表

接口地址:
GET /sign/swapGoogsList
请求参数:

参数	数据类型	必填	参数说明
page	int	X	分页参数
size	int	X	分页参数

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": {
        "datas": [
            {
                "id": 1,
                "name": "名称",
                "summary": "描述",
                "score": 50,//所需金豆
                "stock": 20,//库存
                "exchangeNum": 5,//已经兑换的数量
                "iconUrl": "",//图标地址
                "images": ["",""],//图片列表
                "price": 5.60,//价值
                 "createTime": ""
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

4.05 商品兑换详情

接口地址:
GET /sign/swapGoogs/{id}

路径参数

id：兑换的商品的id

请求参数:

参数	数据类型	必填	参数说明
无

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
        "data": {
             "id": 1,
                "name": "名称",
                "summary": "描述",
                "score": 50,//所需金豆
                "stock": 20,//库存
                "exchangeNum": 5,//已经兑换的数量
                "iconUrl": "",//图标地址
                "images": ["",""],//图片列表
                "price": 5.60,//价值
                "content":"图文详情" 
                "createTime": ""//创建时间
        }
}

4.06兑换商品

接口地址:
POST /sign/swap
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
addressId	int	Y	收货地址id
goodsId	int	Y	兑换的商品的id
quantity	int	Y	数量
remark	String	N	备注

错误码说明

code	错误原因	返回消息
822	不存在的商品	不存在的商品
824	商品已下架	商品已下架
2003	库存不足	库存不足
1101	金豆不足	积分不足

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": null
}

5 其他

5.01 省市区下拉查询 = 2.09

接口地址:
GET /system/selectCities

请求参数:

参数	数据类型	必填	参数说明
levelType	int	N	1省级，2地市级，3区县级；默认1，此时parentId不传或者传入100000
parentId	int	N	所属省或者市的id

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": [{
            "id":440100,
            "parentId":440000,
            "name"："广州市",
            "levelType":2,//层级:1省级，2地市级，3区县级
            "firstChar"："G"//首字母
        },...
    ]
}

5.02 收货地址列表 = 2.28

GET /personal/deliveries
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
page	int	N	分页参数-当前页码
size	int	N	分页参数-页数据量

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 2,
                "customerId": 4,
                "deliveryName": "啦啦啦",//收货人姓名
                "deliveryMobile": "15099998877",//电话
                "provinceId": 340000,//省
                "provinceName": "安徽省",
                "cityId": 340100,//市
                "cityName": "合肥市",
                "areaId": 340103,//区
                "areaName": "庐阳区",
                "address": "翡翠花园"//具体地址
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1,
        "lookup": {
            "page": 1,
            "size": 10,
            "userId": 1,
            "type": 0,
            "status": 0,
            "merchantId": 0
        }
    }
}

5.02 新增收货地址 = 2.29

POST /personal/delivery/add
请求参数:

参数	数据类型	必填	参数说明
customerId	int	Y	用户id
deliveryMobile	String	Y	电话
deliveryName	String	Y	姓名
provinceId	int	Y	省id
cityId	int	Y	市id
areaId	int	Y	地区id
address	String	Y	详细地址

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

5.04 修改收货地址 = 2.30

POST /personal/delivery/update
请求参数:

参数	数据类型	必填	参数说明
id	int	Y	当前地址的id
customerId	int	Y	用户id
deliveryMobile	String	N	电话
deliveryName	String	N	姓名
provinceId	int	N	省id
cityId	int	N	市id
areaId	int	N	地区id
address	String	Y	详细地址

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

5.05 删除收货地址 = 2.31

POST /personal/delivery/{id}/delete
路径参数：
id int 当前地址ID

请求参数:

参数	数据类型	必填	参数说明
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

5.06 会员排行榜 = 2.32

接口地址:
GET `/personal/rankings
请求参数:

参数	数据类型	必填	参数说明
无

错误码说明

code	错误原因	返回消息
无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
        "data": [
            {
                "id": 1,
                "mobile": "13428858800",
                "nickname": "朋度",
                "money": "858",//奖励的金额
                "headpicUrl": "http://jiuchiwl.cn/attachment/attachment/ajax/visit/14353"//头像地址
            }
        ]
}

5.06-1 推荐会员列表 = 2.33

GET /personal/recommendList
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
page	int	N	分页参数-当前页码
size	int	N	分页参数-页数据量

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 2,//用户id
                "mobile": "",//手机号
                "nickname": "啦啦啦",//昵称
                "lastLoginTime": "2018-12-12 12:12"//最后登录时间
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

5.07 意见反馈 = 2.10

接口地址:
POST /system/feedback/add

请求参数:

参数	数据类型	必填	参数说明
customerId	int	Y	用户id
customerName	String	Y	用户姓名
mobile	String	Y	用户电话
content	String	Y	反馈内容
images	String	Y	图片附件ids 形如1,2,3

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": null
}

5.08 轮播图点击 = 2.02 -01

接口地址:
GET /system/banner/{id}

**路径参数 **

id banner的id

请求参数:

参数	数据类型	必填	参数说明
无

错误码说明

code	错误原因	返回消息

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "msg": null,
    "data": null
}

6 2018年11月2日新增

6.01 我的好友统计

GET /personal/friendSurvey
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "total": 10,//累计人数
        "todayNum": 10,//今日人数
        "monthNum": 1//本月人数
    }
}

6.02 我的团队列表

GET /personal/friendList
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
page	int	N	分页参数-当前页码
size	int	N	分页参数-页数据量

响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 2,//用户id
                "contribution": 3.02,//预计贡献
                "nickname": "啦啦啦",//昵称
                "actived" ： true,//是否活跃
                "lastLoginTime": "2018-12-12 12:12"//最后登录时间
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

6.03 订单列表

GET /personal/orderList
请求参数:

参数	数据类型	必填	参数说明
userId	int	Y	用户id
type	int	N	1-有效订单（非订单失效状态） 2-无效订单
orderStatus	String	N	订单结算/订单付款/订单失效/ 订单成功

| page | int | N | 分页参数-当前页码 |
| size | int | N | 分页参数-页数据量 |
响应结果:

{
    "code": 0,
    "msg": "",
    "data": {
        "datas": [
            {
                "id": 2,//用户id
                "orderNo": "X546978978",//订单号
                "orderStatus": "订单付款",//昵称
                "createTime": "2018-12-12 12:12",//创建时间
                "itemInfo":"订单付款",//订单状态
                "payAmount":"10.5",//付款金额
                "itemNum":1,//商品数量
                "price":10.5,//单价
                "customerId":"2",//所属用户id
                "customerName":"张三"//所属用户
            }
        ],
        "total": 1,
        "size": 10,
        "page": 1,
        "pages": 1,
        "curSize": 1
    }
}

聚来宝

一、通用说明

1 一般通用返回JSON格式说明

2 一般返回的列表数据格式说明

3 关于文件上传的一些说明

4 base_url

5 安全

6 通用错误码说明

7 推送说明

8 单手机登录说明

二、接口文档

1 登录注册

1.01 发送短信验证码

1.02 注册账号

1.03 手机号登陆

1.04 手机验证码登录

1.05 微信登陆-第三方登陆

1.06 忘记密码

1.07 修改密码

1.08 退出登录

1.09 绑定手机号

2 全局配置

2.01 启动页列表

2.02轮播图列表

2.03关于我们

2.04 版本更新

2.05 客服电话

2.06 商品分类

2.07 特色商品分类列表

2.08 提现须知

分享

3 个人中心

3.01 获取用户信息

3.02 编辑个人信息

3.03 绑定第三方账户-第三方授权?

3.04 我的收藏列表

3.05 新增/取消收藏> 没有收藏则新增 有收藏则删除

3.06 删除收藏

3.07 最近浏览

3.08 删除最近浏览

3.08 消息通知列表

3.09 消息详情(置为已读)

3.10 删除消息

3.11 会员奖励总额

3.12 会员奖励列表

3.13 会员福利概览

3.14 会员福利列表

3.15我的钱包余额

3.15-1我的钱包概览

3.16账单明细-余额明细

3.17 提现申请

3.18 升级VIP说明

3.19升级VIP

3.20我的团队概览

3.21我的团队列表

3.22宣传物料

3.23 晒晒成绩

3.24 消费积分概览

3.25 消费积分明细

3.26 积分转换

3.27 概览统计 会员奖励 | 消费积分 | 会员福利 | 我的钱包

4 商品相关

4.01 必买清单商品列表

4.02 分类商品列表 || 系统内搜券

4.03 特色分类商品列表.

4.04 9.9专场商品列表

4.05 今日推荐商品列表

4.06 品牌商家列表

4.07 品牌专区商品列表.

4.08 商品详情

4.09 获得针对此用户的推荐链接

4.10 搜索淘宝客商品

4.11 淘宝客商品详情

5 其他

5.1 支付宝回调地址

5.2 微信回调地址

----------------------------------------------------

省惠优选二期

1商品相关

1.01-商品分类 （一级/二级/热卖）

1 `一般通用返回JSON格式说明`

2 `一般返回的列表数据格式说明`

3 `关于文件上传的一些说明`

4 `base_url`

3.05 新增/取消收藏> 没有收藏则新增有收藏则删除

3.27 概览统计会员奖励 | 消费积分 | 会员福利 | 我的钱包

1.01-商品分类（一级/二级/热卖）