一.基础

1.1 用户信息

ID	名字	登入密码	支付密码	地址	手机号码
2	龙	123456	123456	Ox9a6bc985140f4a5b9add5ba9f0378dc67a9dxxxx	173xxxx9588
3	hope	123456	123456	Ox83e6c168a66543d3b9f064a2e9ca47783859xxxx	186xxxx0007
1	管理员	123456	123456	Oxadmin	admin

1.2 请求头

key	value
Content-Type	application/json
Authorization	登入返回的token

1.3 用户角色类型

type	desc
1	管理员
2	用户
3	码主
4	商户
5	代理商

1.4 配置中心类型

type	desc
1	充值配置
2	解冻配置
3	收款码配置
4	币池配置
5	转账配置

1.5 币的种类

key	value
1	QBAC
2	LBAC

二. 用户端

1. 用户登入

1.1 功能描述

用户登入获取授权令牌。请求头不需要Authorization

1.2 请求说明

请求方式：POST
请求URL ：/login

1.3 请求参数

字段	字段类型	是否必须	字段说明
mobile	String	Y	手机号码
password	String	Y	登入密码

1.4 返回结果

{
  "code": 0,
    "data": {
        "isAdmin": false,   是否是管理员
        "token": "用户登入令牌"
    }
}

2. 收款码购买

2.1 功能描述

购买收款码。请求头需要Authorization

2.2 请求说明

请求方式：POST

请求URL ：/user/qrcode/v2/buy

2.3 请求参数

字段	字段类型	是否必须	字段说明
num	int	Y	收款码数量
tradePassword	String	N	支付密码
agentMobile	String	Y	代理商号码

2.4 返回结果

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

3. 码主或者商家获取收款码列表

3.1 功能描述

获取收款码列表。请求头需要Authorization

3.2 请求说明

请求方式：GET
请求URL ：user/qrcode/v2/get_list

3.3 请求参数

字段	字段类型	是否必须	字段说明
curRole	int	Y	3:码主;4:商户

3.4 返回结果

{
  "code": 0,
    "data": [
        {
            "qrcodeContent": " 二维码内容(用来生成二维码的)",     
            "userQrcodeName": "码主命名的收款名字 ",  
            "merchantQrcodeName": "商家命名的收款码名字",  
            "qrcodeId": 6   码的唯一ID 
        }
    ]
}

4. 码主或者商家收款码详情页面

4.1 功能描述

收款码详情页面。请求头需要Authorization

4.2 请求说明

请求方式：GET
请求URL ：/user/qrcode/v2/get_qrcode_detail

4.3 请求参数

字段	字段类型	是否必须	字段说明
curRole	int	Y	3:码主;4:商户
qrcodeId	long	Y	收款码唯一ID

4.4 返回结果

{
"code": 0,
    "data": {
        "qrcodeContent": "二维码内容(用来生成二维码的) ",
        "userQrcodeName": "码主命名的码名字",
        "merchantQrcodeName": "商户命名的码名字",
        "qrcodeId": 243242, 二维码唯一ID
        "merchantId": 222111212,绑定的商家用户唯一ID
        "merchantAddress": "223sdsadsdadasa",绑定的商家用户地址
        "merchantName": "已绑定码的商户名称",
        "qrcodePayDetailVos": [
            {
                "profitAmount": 22.22,收款金额
                "createdTimeStr": "2019-09-02" 收款时间
            }
        ]
    }
}
}

5. 绑定收款码

5.1 功能描述

绑定收款码。请求头需要Authorization

5.2 请求说明

请求方式：POST
请求URL ：/user/qrcode/v2/bind

5.3 请求参数

字段	字段类型	是否必须	字段说明
qrcodeId	long	Y	收款码唯一ID
toAddress	String	Y	要绑定的商家的用户地址
tradePassword	String	Y	支付密码

5.4 返回结果

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

6. 解绑收款码

6.1 功能描述

解绑收款码。请求头需要Authorization

6.2 请求说明

请求方式：POST
请求URL ：/user/qrcode/v2/unbind

6.3 请求参数

字段	字段类型	是否必须	字段说明
qrcodeId	long	Y	收款码唯一ID
tradePassword	String	Y	支付密码

6.4 返回结果

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

7. 转让收款码

7.1 功能描述

转让收款码。请求头需要Authorization

7.2 请求说明

请求方式：POST
请求URL ：/user/qrcode/v2/make_over

7.3 请求参数

字段	字段类型	是否必须	字段说明
qrcodeId	long	Y	收款码唯一ID
toAddress	String	Y	要绑定的商家的用户地址
tradePassword	String	Y	支付密码

7.4 返回结果

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

7. 码主或者商家修改收款码名字

7.1 功能描述

修改收款码名字。请求头需要Authorization

7.2 请求说明

请求方式：POST
请求URL ：/user/qrcode/v2/modify_name

7.3 请求参数

字段	字段类型	是否必须	字段说明
qrcodeId	long	Y	收款码唯一ID
curRole	int	Y	3:码主;4:商户
qrcodeName	String	Y	收款码名字
tradePassword	String	Y	支付密码

7.4 返回结果

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

二. 公共端

8. 根据配置类型获取具体配置

8.1 功能描述

根据配置类型获取具体配置。请求头需要Authorization 用户端管理端都可以用

8.2 请求说明

请求方式：GET
请求URL ：/common/config/v2/get_config_type

8.3 请求参数

字段	字段类型	是否必须	字段说明
type	int	Y	配置类型

8.4 返回结果

{
 "code": 0,
    "data": {
        "giveTotalNum": "3",
        "giveRatio": "0.5",
        "giveMaxRatio": "0.8",
        "giveMinRatio": "0.2",
        "giveFirstRatio": "0.5"
    }
}

三. 管理端

9. 根获取配置中心所有配置

9.1 功能描述

获取配置中心所有配置。请求头需要Authorization并且admin

9.2 请求说明

请求方式：GET
请求URL ：/manage/config/v2/get_configs

9.3 请求参数

无

9.4 返回结果

{
  "code": 0,
    "data": [
        {
            "giveTotalNum": "3",
            "giveRatio": "0.5",
            "giveMaxRatio": "0.8",
            "giveMinRatio": "0.2",
            "giveFirstRatio": "0.5"
        },
        {
            "thawTotalNum": "3"
        },
        {
            "agentRatio": "0.2",
            "firstLevelRatio": "0.2",
            "qrCodePrice": "1000",
            "qrCodeIntroduction": "收款码用于收款",
            "payServiceFee": "0.2",
            "secondLevelRatio": "0.2",
            "letProfitRatio": "0.2",
            "qrCodeUserRatio": "0.2"
        },
        {
            "memberMaxRatio": "0.2",
            "memberMinRatio": "0.2",
            "rewardSwitch": "1"
        },
        {
            "serviceCharge": " 0.01"
        }
    ]
}

9.5 币池配置

{

    /**
     * 会员收益支付金额最小占比
     */
    private Double memberMinRatio;

    /**
     * 会员收益支付金额最大占比
     */
    private Double memberMaxRatio;

    /**
     * 币池奖励开关
     */
    private Integer rewardSwitch;
}

9.6 付款码配置

{
/**
     * 付款码购买单价
     */
    private Integer qrCodePrice;

    /**
     * 收款码描述
     */
    private String qrCodeIntroduction;

    /**
     * 商家让利比率
     */
    private Double letProfitRatio;

    /**
     * 商家让利金额码主占比
     */
    private Double qrCodeUserRatio;

    /**
     * 商家让利金额代理商占比
     */
    private Double agentRatio;

    /**
     * 商家让利金额一级推荐人占比
     */
    private Double firstLevelRatio;

    /**
     * 商家让利金额二级推荐人占比
     */
    private Double secondLevelRatio;

    /**
     * 会员支付手续费比例
     */
    private Double payServiceRatio;
}

9.7 充值配置

{
  /**
     * 快速充值赠送部分最小占比
     */
    private Double giveMinRatio;

    /**
     * 快速充值赠送部分最大占比
     */
    private Double giveMaxRatio;

    /**
     * 缓慢充值赠送部分占比
     */
    private Double giveRatio;

    /**
     * 缓慢充值剩余部分到账分期数
     */
    private Integer giveTotalNum;

    /**
     * 缓慢充值首次到账金额占比
     */
    private Double giveFirstRatio;
}

9.8 解冻配置

{
    /**
     * 解冻分期
     */
    private Integer thawTotalNum;
}

9.9 转账配置

{
    /**
     * 转账手续费比率
     */
    private Double serviceChargeRatio;
}

10. 管理员充值

10.1 功能描述

管理员充值：资金由管理员账号到用户账号，没有手续费

10.2 请求说明

请求方式：POST
请求URL ：/manage/recharge/v2/pay

10.3 请求参数

字段	类型	是否必须	描述
toAddress	String	是	到账地址
agentAddress	String	否	代理商地址
amount	Double	是	充值金额
type	Integer	是	充值到账类型 1：快速到账 2：分期到账
tradePassword	String	是	交易密码
giveRatio	Double	是	赠送占比，不赠送传0
firstRatio	Double	否	type=2 分期到账，首次到账金额比例
period	Integer	否	type=2 分期到账，分期数

10.4 返回结果

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

11. 转账

11.1 功能描述

管理员转账：后台操作，资金由管理员账号到用户账号，有手续费
用户之间转账：用户操作，资金由A账号到B账号，有手续费

11.2 请求说明

请求方式：POST
请求URL ：/common/amount/v2/send

11.3 请求参数

字段	类型	是否必须	描述
toAddress	String	是	到账地址
amount	Double	是	转账金额
tradePassword	String	是	交易密码

11.4 返回结果

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

12. 用户列表

12.1 功能描述

管理端查询用户列表，组合查询条件，至少有一项。

12.2 请求说明

请求方式：POST
请求URL ：/manage/user/v2/get_users_query

12.3 请求参数

字段	类型	是否必须	描述
phone	String	否	手机号码
address	String	否	用户地址
name	String	否	昵称
role	Integer	否	角色
createTimeSort	Boolean	否	会员时间排序 TRUE:desc FALSE:asc
amountSort	Boolean	否	账户金额排序 TRUE:desc FALSE:asc
pageIndex	Integer	是	页码
pageSize	Integer	是	每页数量

12.4 返回结果

字段	类型	描述
nick	String	用户昵称
mobile	String	手机号码
address	String	用户地址
balance	Double	余额
role	String	角色（封装好的 String 展示即可）
createdTimeStr	String	会员加入时间
firstRecommendNum	Integer	一级推荐数
secondRecommendNum	Integer	二级推荐数
frozenBtn	Integer	冻结按钮 0隐藏 1显示
thawBtn	Integer	解冻按钮 0隐藏 1显示
agentBtn	Integer	升级代理按钮 0隐藏 1显示

13 . 升级为代理商

13.1 功能描述

管理端将用户升级为代理商

13.2 请求说明

请求方式：POST
请求URL ：/manage/user/v2/upgrade_agent

13.3 请求参数

字段	类型	是否必须	描述
id	Long	是	用户 id

13.4 返回结果

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

QBAC接口文档

一.基础

1.1 用户信息

1.2 请求头

1.3 用户角色类型

1.4 配置中心类型

1.5 币的种类

二. 用户端

1. 用户登入

1.1 功能描述

1.2 请求说明

1.3 请求参数

1.4 返回结果

2. 收款码购买

2.1 功能描述

2.2 请求说明

2.3 请求参数

2.4 返回结果

3. 码主或者商家获取收款码列表

3.1 功能描述

3.2 请求说明

3.3 请求参数

3.4 返回结果

4. 码主或者商家收款码详情页面

4.1 功能描述

4.2 请求说明

4.3 请求参数

4.4 返回结果

5. 绑定收款码

5.1 功能描述

5.2 请求说明

5.3 请求参数

5.4 返回结果

6. 解绑收款码

6.1 功能描述

6.2 请求说明

6.3 请求参数

6.4 返回结果

7. 转让收款码

7.1 功能描述

7.2 请求说明

7.3 请求参数

7.4 返回结果

7. 码主或者商家修改收款码名字

7.1 功能描述

7.2 请求说明

7.3 请求参数

7.4 返回结果

二. 公共端

8. 根据配置类型获取具体配置

8.1 功能描述

8.2 请求说明

8.3 请求参数

8.4 返回结果

三. 管理端

9. 根获取配置中心所有配置

9.1 功能描述

9.2 请求说明

9.3 请求参数

9.4 返回结果

9.5 币池配置

9.6 付款码配置

9.7 充值配置

9.8 解冻配置

9.9 转账配置

10. 管理员充值

10.1 功能描述

10.2 请求说明

10.3 请求参数

10.4 返回结果

11. 转账

11.1 功能描述

11.2 请求说明

11.3 请求参数

11.4 返回结果

12. 用户列表

12.1 功能描述

12.2 请求说明

12.3 请求参数

12.4 返回结果