@BurdenBear 2017-06-21T02:54:49.000000Z 字数 5580 阅读 425

大鱼策略商城API文档（机构用户部分）

API文档 策略商城

机构用户相关

000001 机构用户登录

method POST
URL: /business/login/

request:

  {
    "code": -2, # 图片验证码
    "username": "13955133760",
    "password": "p541795600"
  }

response:

登录成功

  {
    "code": 200,
    "data": {"success": 1}
    "message": "BurdenBear" # 所登录的用户的昵称
  }

登录失败

  {
    "code": 200,
    "data": {"success": 0},
    "message": "账号或密码不正确" # 登录失败原因
  }

000002 机构用户登出

method GET
URL: /business/logout/

response:

请求成功

  {
    "code": 200,
    "data": "",
    "message": ""
  }

请求失败

  {
    "code": 500,
    "data": "",
    "message": ""
  }

选购页面相关

100001 获取选购清单

method GET
URL： /business/purchase/bill

request:

{
  "tsFilter":  0, # 筛选试用状态,为0表示获取全部,或者为trialStatus中的对应项
  "bsFilter":  0 # 筛选购买状态,为0表示获取全部,或者为buyingStatus中的枚举值
}

response:

请求成功

  {
    "code": 200,
    "data": [
      {
        "name": "天河一号",
        "identity": "5afb12123nasdf1",
        "trialStatus"： 1, # 试用状态
        "trialExpired": "YYYY/mm/dd HH:MM:SS",
        "buyingStatus": 2, # 购买状态
        "buyingExpired": "YYYY/mm/dd HH:MM:SS"
      }
      ...
    ],
    "message": ""
  }

请求失败

  {
    "code": 500,
    "data": [],
    "message": "内部服务器错误"
  }

枚举量说明：
- trialStatus 试用状态,（int）。
数值释义

1 canTry 可试用

2 onTrial 试用中

3 due 即将到期

4 expired 已经过期
- buyingStatus购买状态（int）。
数值释义

0 all 全部

1 neverBought 从未购买

2 inUse 使用中

3 due 即将过期

4 expired 已经过期

数值	释义
1	canTry 可试用
2	onTrial 试用中
3	due 即将到期
4	expired 已经过期

数值	释义
0	all 全部
1	neverBought 从未购买
2	inUse 使用中
3	due 即将过期
4	expired 已经过期

100002 添加策略到选购清单

method POST
URL： /business/purchase/bill

request:

单个添加
```
{
  "strategies" : "牛气冲天"
}
```

批量添加

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {
    "success": 3, # 成功添加的个数
    "repeated": 0, # 重复添加的个数
    "error": [] # 不存在或下架的策略列表
    # 单个添加时，success不为0,成功；repeated不为0，已存在；两者都为0，策略不存在或已下架
  },
  "message": ""
}

请求失败

{
  "status": 500,
  "data": {
    "success": 0,
    "repeated": 0,
    "error": []
  }
  "message": "内部服务器错误"
}

100003 从购物清单删除策略

method POST
URL: /business/purchase/bill/delete/

request:

单个删除
```
{
  "strategies" : "牛气冲天"
}
```

批量删除

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {
    "success": 3 # 成功删除的策略数
  }, 
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {
    "success": 0
  },
  "message": "内部服务器错误"
}

100004 试用策略

method POST
URL: /business/purchase/trial/

request:

单个试用
```
{
  "strategies" : "牛气冲天"
}
```

批量试用

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {
      "success": 0 # 成功试用的策略数
      "error": [
          {
              "name": "牛气冲天",
              "identity": "5afb12123nasdf1"
              "strategyError": 1
          }
          ...
      ]
  }
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {
      "success": 0 # 成功试用的策略数
      "error": []
  }
  "message": "内部服务器错误"
}

枚举常量
- strategyError策略错误(int)。
数值释义

1 策略不存在或下架

2 策略已被试用

数值	释义
1	策略不存在或下架
2	策略已被试用

100005 获取策略详细信息

method POST
URL: /business/purchase/strategy/
request:
```
{
  "strategies": ["1", "2"],    
}
```

response:

  [
    {
      "exist": True, # 这个值为True表示策略存在，为False表示不存在或者说策略已经下架
      "identity": "1", 
      "name": "",
      "price": 500,
      "expiredTime": "YYYY/mm/dd HH:MM:SS",  # 如果已经过期了则会返回当前的时间
    }
    # 按输入顺序排列
    ...
  ]

100006 购买策略

method POST
URL: /business/purchase/deal/

request:

单个购买

{
  "strategies" : ["牛气冲天"], # 策略名或id
  "period": [1] # 购买月份数
}

批量购买

{
  "strategies": ["天河一号", "天河二号", "天河三号"] # 策略名或id
  "period": [1, 1, 1] # 购买月份数。
}

非法请求

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {"success": 3 # 成功购买的策略数},
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {"success": 0},
  "message": "内部服务器错误"
}

控制台相关

200001 获取控制台策略

method GET
URL: /business/purchase/deal

request:

{
  "rsFilter":  0, # 筛选试用状态,为0表示获取全部,或者为runningStatus中的对应项
  "esFilter":  0 # 筛选使用时间状态,为0表示获取全部,或者为expiringStatus中的枚举值
}

response:

请求成功

  {
    "code": 200,
    "data": [
      {
        "name": "天河一号",
        "identity": "5afb12123nasdf1",
        "runningStatus"： 1, # 运行状态
        "expiringStatus": 2, # 购买状态
        "expiredTime": "YYYY/mm/dd HH:MM:SS"
      }
      ...
    ],
    "message": ""
  }

请求失败

  {
    "code": 500,
    "data": [],
    "message": "内部服务器错误"
  }

枚举常量
- runningStatus 试用状态(int)
数值释义

0 all 全部

1 running 启用中

2 stop 已停止
- expiringStatus购买状态(int)
数值释义

0 all 全部

1 inUse 使用中

2 due 即将过期

3 expired 已经过期

数值	释义
0	all 全部
1	running 启用中
2	stop 已停止

数值	释义
0	all 全部
1	inUse 使用中
2	due 即将过期
3	expired 已经过期

200002 删除控制台策略

method: POST
URL: /business/purcharse/deal/delete

request:

单个删除
```
{
  "strategies" : "牛气冲天"
}
```

批量删除

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {"success": 3 # 成功删除的个数}
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {"success": 0},
  "message": "内部服务器错误"
}

200003 启用选中策略

method: POST
URL: /business/control/running/start/

request:

单个启用
```
{
  "strategies" : "牛气冲天"
}
```

批量启用

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {"success": 3 # 成功启用的个数},
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {"success": 0},
  "message": "内部服务器错误"
}

200004 停止选中策略

method: POST
URL: /business/control/running/stop/

request:

单个停止
```
{
  "strategies" : "牛气冲天"
}
```

批量停止

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {"success": 3}, # 成功停止的个数
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {"success": 0},
  "message": "内部服务器错误"
}

200005 开启自动续费

method: POST
URL: /business/control/autorenew/start/

request:

单个开启
```
{
  "strategies" : "牛气冲天"
}
```

批量开启

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {"success": 3 # 成功开启的个数},
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {"success": 0},
  "message": "内部服务器错误"
}

200006 关闭自动续费

method: POST
URL: /business/control/autorenew/stop/

request:

单个关闭
```
{
  "strategies" : "牛气冲天"
}
```

批量关闭

{
  "strategies": ["天河一号", "天河二号"， "天河三号"]
}

非法请求

{
  "strategy": ["天河一号", "天河二号"， "天河三号"]
}

response:

请求成功

{
  "code": 200,
  "data": {"success": 3} # 成功关闭的个数
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {"success": 0} 
  "message": "内部服务器错误",
}

账单页面相关

300001 获取订单

method: GET
URL: /business/purchase/order/

request:

{
  "start": "YYYY/mm/dd HH:MM:SS",  # 为空表示从最早开始
  "end": "YYYY/mm/dd HH:MM:SS"    # 为空表示到最后为止
}

response:

请求成功

{
  "code": 200,
  "data": [
    {
      "id": "订单编号",
      "time": "YYYY/mm/dd HH:MM:SS",
      "totalPrice": 1000, # 订单总价 
      "paid": 888, # 实际收款
      "discount": 0.888, # 折扣率
    }
    ... # 按时间顺序排列s
  ],
  "message": ""
}

请求失败

{
  "code": 500,
  "data": [],
  "message": "内部服务器错误"
}

300002 获取订单详情

method: GET
URL: /business/purchase/order/:orderid

response:

请求成功

{
  "code": 200,
  "data": {
      "strategies": [
         {
           "name": "牛气冲天", # 策略名
           "id": "5afb12123nasdf1", # 策略ID
           "period": 1, # 购买月份数
           "price": 500 # 策略每月单价
         }
         ... # 按ID或名字顺序排列s
      ]
      "totalPrice": 1000, # 订单总价 
      "paid": 888 # 实际收款
      "discount": 0.888 # 折扣率
  }
  "message": "" # 
}

请求失败

{
 "code": 500,
 "data": {}
 "message": "内部服务器错误" 
}

找不到对象

{
 "code": 400,
 "data": {},
 "message": "找不到订单"
}

300002 订单退款 (暂时可能不做)

method: DELETE
URL: /business/purchase/order/:orderid

response：

请求成功

{
  "code": 200,
  "data": {},
  "message": ""
}

请求失败

{
  "code": 500,
  "data": {},
  "message": ""
}

大鱼策略商城API文档（机构用户部分）

机构用户相关

000001 机构用户登录

000002 机构用户登出

选购页面相关

100001 获取选购清单

100002 添加策略到选购清单

100003 从购物清单删除策略

100004 试用策略

100005 获取策略详细信息

100006 购买策略

控制台相关

200001 获取控制台策略

200002 删除控制台策略

200003 启用选中策略

200004 停止选中策略

200005 开启自动续费

200006 关闭自动续费

账单页面相关

300001 获取订单

300002 获取订单详情

300002 订单退款 (暂时可能不做)

内容目录

选择主题