Skip to content
This repository has been archived by the owner on Feb 4, 2020. It is now read-only.

Api

Jump to bottom
EchoLZY edited this page Aug 28, 2018 · 11 revisions

Api

本页主要说明了请求的 Api 接口,所有交互均是 json 格式

获取当前是否在活动时间内或者长期

  • 接口描述：用来判断用户是否可以兑换
  • 请求路径：/status
  • 请求方式：GET
  • 请求参数：无
  • 返回结果示例:
{
  "code": "请求代码",
  "msg": "请求结果",
  "data": {
    "body": "boolean 是否在活动时间内",
    "start": "活动开始时间",
    "end": "活动结束时间",
    "long": "是否是长期活动"
    }
  }
}
  • 补充：此接口首先判断 body 是否在时间内，然后再判断 long 是否为长期活动，如果是，就不读取 start 和 end。如果不是，就读取并显示出来。

获取可兑换的类型信息

  • 接口描述：获取兑换类型的数据，生成可兑换类型的按钮
  • 请求路径：/
  • 请求方式：GET
  • 请求参数：
{
    "verify_request" : "加密授权参数",
    "state" : "易班防跨站伪造参数"
}
  • 返回结果示例:
{
  "code": "请求代码",
  "msg": "请求结果",
  "data": {
    "list": [
      {
        "id": "主键",
        "needSteps": "需要的步数",
        "getMoney": "花费的网薪"
      },
      {
        "id": "主键",
        "needSteps": "需要的步数",
        "getMoney": "花费的网薪"
      }
    ]
  }
}

获取当前步数以及最近三十天的运动步数

  • 接口描述：获取易班运动数据，初始化图和运动数据。
  • 请求路径：/steps
  • 请求方式：GET
  • 请求参数：
{
    "verify_request" : "加密授权参数",
    "state" : "易班防跨站伪造参数"
}
  • 返回结果示例:
{
  "code": "请求代码",
  "msg": "请求结果",
  "data": {
    "sport_steps": "今日运动步数",
    "date_time": "今日时间",
    "list": [
      {
        "sport_steps": "步数",
        "date_time": "时间"
      },
      {
        "sport_steps": "步数",
        "date_time": "时间"
      }
    ]
  }
}

获取已经兑换的列表信息

  • 接口描述：获取已近数据，初始化兑换记录。
  • 请求路径：/buyList
  • 请求方式：GET
  • 请求参数：
{
    "verify_request" : "加密授权参数",
    "state" : "易班防跨站伪造参数"
}
  • 返回结果示例:
{
  "code": "请求代码",
  "msg": "请求结果",
  "data": {
    "sport_steps": "今日运动步数",
    "date_time": "今日时间",
    "list": [
      {
        "date": "兑换时间",
        "get_money": "获得网薪",
        "is_enable": "是否已经发放"
      },
      {
        "date": "兑换时间",
        "get_money": "获得网薪",
        "is_enable": "是否已经发放"
      }
    ]
  }
}

发起兑换

  • 接口描述：发起兑换请求
  • 请求路径：/buy
  • 请求方式：POST
  • 请求参数：
{
    "verify_request" : "加密授权参数",
    "state" : "易班防跨站伪造参数",
    "parameter.typeId": "兑换类型",
    "parameter.sportSteps": "兑换步数"
}
  • 返回结果示例
{
  "code": "请求代码",
  "msg": "请求结果",
  "data": {
    "status": "success | failed 是否成功",
    "message": "如果失败，回显信息"
    }
  }
}

Copyright © 2017-2018 by 贵民大易班工作站 EchoCow

All rights reserved.

Clone this wiki locally