[关闭]
@zongwu 2017-04-21T02:10:00.000000Z 字数 8186 阅读 358

海老大第一期接口设计

海老大

注意

1.基础功能

1.1 登录

  1. 接口名：/basic/login
  2. 参数： 
  3.     1. phone(选填)
  4.     2. email(选填)
  5.     3. password
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model": {
  12.         "sessionId":"1234567890"// 登录凭据，前台凭sessionId调用需鉴权的服务
  13.     }
  14. }

1.2 注册

  1. 接口名：/basic/register
  2. 参数： 
  3.     1. phone(选填)
  4.     2. email(选填)
  5.     3. password
  6.     4. verifyCode -- 验证码
  7. 返回： 
  8. {
  9.     "success": true,
  10.     "msgCode": null,
  11.     "msgInfo": null,
  12.     "model": {
  13.         "bool":true
  14.     }
  15. }

1.3 发送验证码

  1. 接口名：/basic/sendVerifyCode
  2. 参数： 
  3.     1. phone(选填)
  4.     2. email(选填)
  5.     3. type -- 业务场景
  6. ---------------------------------
  7. type = register，用于注册时身份验证；
  8. type = forget ，用于找回密码时身份验证；
  9. type = withdraw ，用于申请提现身份验证；
  10. type = transactionPwd，用于设置或修改交易密码；
  11. // TODO 更多待补充
  12. ---------------------------------
  13. 返回： 
  14. {
  15.     "success": true,
  16.     "msgCode": null,
  17.     "msgInfo": null,
  18.     "model": {
  19.         "bool":true
  20.     }
  21. }

1.4 修改密码

  1. 接口名：/user/password/update
  2. 参数： 
  3.     1. sessionId
  4.     2. oldPassword
  5.     3. newPassword
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model": {
  12.         "bool":true
  13.     }
  14. }

1.4 修改资料

  1. 接口名：/user/profile/update
  2. 参数： 
  3.     1. sessionId
  4.     2. nickName -- 昵称
  5.     3. avatar -- 头像
  6.     4. gender -- 性别
  7. 返回： 
  8. {
  9.     "success": true,
  10.     "msgCode": null,
  11.     "msgInfo": null,
  12.     "model": {
  13.         "bool":true
  14.     }
  15. }

1.4 获取资料

  1. 接口名：/user/profile/fetch
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "nickName": "陈俊棋",
  11.         "avatar": "www.baidu.com/avatar.png",
  12.         "gender": "男",
  13.         "isAuthenticate":true // -- 是否实名认证
  14.     }
  15. }

1.5 提交实名认证工单

  1. 接口名：/user/profile/authenticate
  2. 参数： 
  3.     1. sessionId
  4.     2. idCard -- 身份证号码
  5.     3. realName -- 真实姓名
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model": {
  12.         "bool":true
  13.     }
  14. }

2.资金相关

2.1 查询资金状态

  1. 接口名：/user/bank/fetch
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "gold": {
  11.             "total": 1000.4, // -- 总数量
  12.             "active": 500,  // -- 激活数量
  13.             "freeze": 600.4 // -- 冻结数量
  14.         },
  15.         "silver": {
  16.             "total": 1000.4,
  17.             "active": 500,
  18.             "freeze": 600.4
  19.         },
  20.         "rmb": {
  21.             "total": 1000.4
  22.         }
  23.     }
  24. }

2.2 修改银行卡信息

  1. 接口名：/user/bankCard/update
  2. 参数： 
  3.     1. sessionId
  4.     2. bankNum          // -- 银行卡号
  5.     3. bankCreateVendor // -- 银行卡开户行（如：杭州支行）
  6.     4. bankRealName     // -- 银行卡开户名
  7.     5. bank             // -- 银行卡机构（如：中国建设银行）
  8. 返回： 
  9. {
  10.     "success": true,
  11.     "msgCode": null,
  12.     "msgInfo": null,
  13.     "model": {
  14.         "bool":true
  15.     }
  16. }

2.3 提交申请提现工单

  1. 接口名：/user/bank/withdraw
  2. 参数： 
  3.     1. sessionId
  4.     2. number   // -- 提现金额
  5.     3. verifyCode // -- 验证码
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model": {
  12.         "bool":true
  13.     }
  14. }

2.4 查询提现工单状态

  1. 接口名：/user/bank/withdrawContext
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "date": "2016-09-12 18:09:34",
  13.                 "money": "304.5",
  14.                 "status": "审批中"
  15.             },
  16.             {
  17.                 "date": "2016-09-19 18:09:34",
  18.                 "money": "404.5",
  19.                 "status": "已通过"
  20.             }
  21.         ]
  22.     }
  23. }

2.5 提交充值工单

  1. 接口名：/user/bank/recharge
  2. 参数： 
  3.     1. sessionId
  4.     2. number   // -- 充值金额
  5.     3. type     // -- 充值类型
  6. ----------------------------------
  7. type = money , 充值到余额
  8. type = fx , 分销系统保证金
  9. ----------------------------------
  10. 返回： 
  11. {
  12.     "success": true,
  13.     "msgCode": null,
  14.     "msgInfo": null,
  15.     "model": {
  16.         "bool":true
  17.     }
  18. }

2.6 设置启用交易密码

  1. 接口名：/user/transactionPassword/status
  2. 参数： 
  3.     1. sessionId
  4.     2. isUsePassword // -- 是否启用交易密码
  5. 返回： 
  6. {
  7.     "success": true,
  8.     "msgCode": null,
  9.     "msgInfo": null,
  10.     "model": {
  11.         "bool":true
  12.     }
  13. }

2.6 设置启用交易密码

  1. 接口名：/user/transactionPassword/update
  2. 参数： 
  3.     1. sessionId
  4.     2. password // -- 交易密码
  5.     3. verifyCode // --  验证码
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model": {
  12.         "bool":true
  13.     }
  14. }

3. 日志相关

3.1 充值日志

  1. 接口名：/user/log/recharge
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "date": "2016-09-12 18:09:34",
  13.                 "money": "304.5",
  14.                 "status": "已到账"
  15.             },
  16.             {
  17.                 "date": "2016-09-19 18:09:34",
  18.                 "money": "404.5",
  19.                 "status": "进行中"
  20.             }
  21.         ]
  22.     }
  23. }

3.2 提现日志

  1. 接口名：/user/log/withdraw
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "date": "2016-09-12 18:09:34",
  13.                 "money": "304.5",
  14.                 "status": "已提现"
  15.             },
  16.             {
  17.                 "date": "2016-09-19 18:09:34",
  18.                 "money": "404.5",
  19.                 "status": "进行中"
  20.             }
  21.         ]
  22.     }
  23. }

3.3 查看推荐日志

  1. 接口名：/user/log/preRelation/recommend
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "date": "2016-09-19 18:09:34",
  13.                 "phone": "18668247775",
  14.                 "level": "高级业务经理"
  15.             },
  16.             {
  17.                 "date": "2016-09-19 18:09:34",
  18.                 "phone": "18668246666",
  19.                 "level": "中级业务经理"
  20.             }
  21.         ]
  22.     }
  23. }

3.4 查看发展日志

  1. 接口名：/user/log/preRelation/develop
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "date": "2016-09-19 18:09:34",
  13.                 "phone": "18668247775",
  14.                 "level": "高级业务经理"
  15.             },
  16.             {
  17.                 "date": "2016-09-19 18:09:34",
  18.                 "phone": "18668246666",
  19.                 "level": "中级业务经理"
  20.             }
  21.         ]
  22.     }
  23. }

4. 业务员、商户相关

4.1 修改商户信息（每次修改都需要后台审批）

  1. 接口名：/user/vendor/update
  2. 参数： 
  3.     1. sessionId
  4.     2. vendorName
  5.     3. vendorLogo
  6.     4. vendorAddress
  7.     5. vendorPhone
  8.     6. vendorAuthenticate // -- 营业执照
  9.     7. vendorType   // -- 商铺类型
  10. 返回： 
  11. {
  12.     "success": true,
  13.     "msgCode": null,
  14.     "msgInfo": null,
  15.     "model":  {
  16.         "bool":true
  17.     }
  18. }

4.2 获取商户信息

  1. 接口名：/user/vendor/fetch
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "vendorName":"海老大",
  11.         "vendorLogo":"www.baidu.com/logo.png",
  12.         "vendorAddress":"浙江省杭州市周山区群岛",
  13.         "vendorPhone":"0571-12345678",
  14.         "vendorAuthenticate":"www.baidu.com/authenticate.png",
  15.         "vendorType":"餐饮类",
  16.         "status":"已审批通过"   // 商户认证状态
  17.     }
  18. }

4.3 设置商户的返豆比例

  1. 接口名：/user/vendor/beanSetting/update
  2. 参数： 
  3.     1. sessionId
  4.     2. number // -- 返豆比例
  5. 返回： 
  6. {
  7.     "success": true,
  8.     "msgCode": null,
  9.     "msgInfo": null,
  10.     "model":  {
  11.         "bool":true
  12.     }
  13. }

4.4 填写业务员申请工单

  1. 接口名：/user/fx/update
  2. 参数： 
  3.     1. sessionId
  4.     2. level // -- 业务员等级
  5.     3. reason // -- 申请理由
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model":  {
  12.         "bool":true
  13.     }
  14. }

4.5 获取业务员申请工单状态

  1. 接口名：/user/fx/status
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "total": 1, // -- 工单完整状态
  11.         "list": {
  12.             "info": 1,      // -- 基本信息认证状态
  13.             "vendor": -1,   // -- 合作商信息认证状态
  14.             "rmb": 1        // -- 保证金信息认证状态
  15.         }
  16.     }
  17. }

4.6 查询自己是否被别人推荐

  1. 接口名：/user/fx/recommend/fetch
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "title": "您有一条推荐信息",
  11.         "detail": "陈俊棋推荐您成为中级业务经理！",
  12.     }
  13. }
  14. // 呈现对话框即可，确认就跳转到业务员申请表。

4.7 预建推荐关系(如：A 推荐 B 去注册，但 B 可能未注册)

  1. 接口名：/user/fx/preRelation/recommend
  2. 参数： 
  3.     1. sessionId
  4.     2. email or phone
  5.     3. userType // 用户类型：1是普通用户，2是业务员，3是商户
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model":  {
  12.         "url":"http://www.baidu.com?rc=123"// 推荐地址，扫这个地址可以快速注册
  13.     }
  14. }
  15. // rc = 推荐人的用户 id

4.8 预建发展关系(如：A 发展 B 去注册，但 B 可能未注册)

  1. 接口名：/user/fx/preRelation/develop
  2. 参数： 
  3.     1. sessionId
  4.     2. email or phone
  5.     3. userType // 用户类型：1是普通用户，2是业务员，3是商户
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model":  {
  12.         "url":"http://www.baidu.com?rc=123"// 发展地址，扫这个地址可以快速注册
  13.     }
  14. }
  15. // rc = 推荐人的用户 id

4.9 查看分销总业绩

  1. 接口名：/user/fx/fetch
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "recommend": {
  11.             "total": 100,// 共计推荐人数
  12.             "business": 24,// 业务员
  13.             "vendor": 2,// 商户
  14.             "user": 64// 普通用户
  15.         },
  16.         "develop": {
  17.             "total": 100,
  18.             "business": 24,
  19.             "vendor": 2,
  20.             "user": 64
  21.         }
  22.     }
  23. }

5. 管理后台

5.1 获取业务员申请审批列表

  1. 接口名：/manager/approval/business/list
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list":    [
  11.             {
  12.                 "uid": 123,             // 用户 id
  13.                 "realname": "张三",
  14.                 "origin": "用户",       // 现在的身份
  15.                 "approve": "中级业务经理",// 申请的身份
  16.                 "margin": "保证金已缴纳", // 是否缴纳保证金
  17.                 "recommend": 67,        // 推荐人，若没有传-1
  18.                 "develop": 34           // 直接上线，若没有传-1
  19.             }
  20.         ]
  21.     }
  22. }

5.2 获取商户信息审批列表

  1. 接口名：/manager/approval/vendor/list
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "uid": 124,
  13.                 "vendorName": "海老大",
  14.                 "vendorLogo": "www.baidu.com/logo.png",
  15.                 "vendorAddress": "浙江省杭州市周山区群岛",
  16.                 "vendorPhone": "0571-12345678",
  17.                 "vendorAuthenticate": "www.baidu.com/authenticate.png",
  18.                 "vendorType": "餐饮类"
  19.             }
  20.         ]
  21.     }
  22. }

5.3 获取用户的实名信息认证审批列表

  1. 接口名：/manager/approval/verified/list
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "uid": 123,
  13.                 "idCard": "321xxxxxxxxxxxxxxxx",
  14.                 "realName": " 张三"
  15.             }
  16.         ]
  17.     }
  18. }

5.4 获取提现审批列表

  1. 接口名：/manager/approval/withdraw/list
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "list": [
  11.             {
  12.                 "uid": 123,
  13.                 "gold": {
  14.                     "total": 1000.4,
  15.                     "active": 500,
  16.                     "freeze": 600.4
  17.                 },
  18.                 "silver": {
  19.                     "total": 1000.4,
  20.                     "active": 500,
  21.                     "freeze": 600.4
  22.                 },
  23.                 "rmb": {
  24.                     "total": 1000.4
  25.                 },
  26.                 "withdraw": 1000,
  27.                 "date": "2017-09-12 18:00:00"
  28.             }
  29.         ]
  30.     }
  31. }

5.5 获取充值审批列表

  1. 接口名：/manager/approval/recharge/list
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": [
  10.         {
  11.             "uid": 123,
  12.             "type": "fx",
  13.             "number": 1000,
  14.             "date": "2017-09-12 18:00:00"
  15.         }
  16.     ]
  17. }

5.6 设置分销分成比例

  1. 接口名：/manager/fx/develop/percent
  2. 参数： 
  3.     1. sessionId
  4.     2. uid (选填)，不填即对全局的修改
  5.     3. level_max // 高级
  6.     4. level_mid // 中
  7.     5. level_min // 低
  8. 返回： 
  9. {
  10.     "success": true,
  11.     "msgCode": null,
  12.     "msgInfo": null,
  13.     "model": {
  14.         "bool":true
  15.     }
  16. }

5.7 设置推荐分成比例

  1. 接口名：/manager/fx/recommend/percent
  2. 参数： 
  3.     1. sessionId
  4.     2. uid (选填)，不填即对全局的修改
  5.     3. percent
  6. 返回： 
  7. {
  8.     "success": true,
  9.     "msgCode": null,
  10.     "msgInfo": null,
  11.     "model": {
  12.         "bool":true
  13.     }
  14. }

5.8 提升分销链中的分销员等级

  1. 接口名：/manager/fx/develop/levelUp
  2. 参数： 
  3.     1. sessionId
  4.     2. uid
  5. 返回： 
  6. {
  7.     "success": true,
  8.     "msgCode": null,
  9.     "msgInfo": null,
  10.     "model": {
  11.         "bool":true
  12.     }
  13. }

5.9 给用户发钱

  1. 接口名：/manager/fx/reward
  2. 参数： 
  3.     1. sessionId
  4.     2. uid
  5.     3. type // 金豆、银豆
  6.     4. freeze // 冻结截止日期，距离1970年的时间戳
  7.     5. number 
  8. 返回： 
  9. {
  10.     "success": true,
  11.     "msgCode": null,
  12.     "msgInfo": null,
  13.     "model": {
  14.         "bool":true
  15.     }
  16. }

5.10 查看平台内总体资金状态(定时器一天一查，不实时查库)

  1. 接口名：/manager/fetch
  2. 参数： 
  3.     1. sessionId
  4. 返回： 
  5. {
  6.     "success": true,
  7.     "msgCode": null,
  8.     "msgInfo": null,
  9.     "model": {
  10.         "gold": {
  11.             "total": 1000.4,
  12.             "active": 500,
  13.             "freeze": 600.4
  14.         },
  15.         "silver": {
  16.             "total": 1000.4,
  17.             "active": 500,
  18.             "freeze": 600.4
  19.         },
  20.         "rmb": {
  21.             "total": 1000.4
  22.         },
  23.         "total": 100,
  24.         "business": 24,
  25.         "vendor": 2,
  26.         "user": 64
  27.     }
  28. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注