@lina 2018-10-30T05:55:34.000000Z 字数 22519 阅读 640

闪电产品端1.0 微信端接口文档

列表项

闪电 1.0 wechat

1、项目约定

1.1 基本约定

1.1.1 API Base Url

【测试url】https://api.flash.alpha.flashdiet.cn/api/v1

【线上url】https://api.flashdiet.cn/api/v1

1.1.2 鉴权字段(身份标识)

token : [string] 登录后获取的 token 信息

1.1.3 HTTP请求中字段要求

POST请求Content-Type为：Content-Type:application/x-www-form-urlencoded

文件上传时Content-Type为：Content-Type:multipart/form-data

对于：Content-Type:application/json、：Content-Type:application/xml不保证完全支持，请谨慎使用

1.1.4 图片裁图规则

按宽度等比例缩放，http://image.com/logo.jpg?100x0，将logo.jpg按宽度100px进行等比例缩放

按高度等比例缩放，http://image.com/logo.jpg?0x100，将logo.jpg按高度100px进行等比例缩放

裁图，http://image.com/logo.jpg?100x80，将logo.jpg以图片中心为原点裁成100px宽，80px高的图

1.2 通用接口

1.2.1 通用接口URL

【线上url】待定

【测试url】https://api.flash.alpha.flashdiet.cn/api/

【线上url】https://api.flashdiet.cn/api/

1.2.2 上传图片

通用图片上传文件服务

请求URL

POST
/imgupload

请求参数

file : 文件

响应

{
    error_code: 0,
    data: {
        url: 'http://xxx'
    }
}

url : [string] 文件的访问URL

1.2.3 验证码图片

注：请求图片时，需解析图片的cookie，不然无法认证

GET
/captcha/app

1.2.4 发送短信

POST
/verifycode

请求参数

captcha_code : [string] 图形验证码

phone : [string] 手机号

响应

{
    error_code: 0,
    data: {
        url: 'http://xxx'
    }
}

1.2.5 城市列表接口【v4.0新增】

请求URL

get
/city

请求参数

parent_id : [integer] 当不传值时，取parent_id=0的数据，即省、直辖市

响应

{
    error_code: 0,
    data: {
        "list": [
            {
              "id": 0,
              "parent_id": 0,
              "name": "string",
              "short_name": "string",
              "pinyin": "string",
              "sort": 0,
            }
        ]
    }
}

1.2.6 城市下区域接口【v4.0新增】

请求URL

get
/area/city

请求参数

name : [string] 城市名称

响应

{
    error_code: 0,
    data: {
        "list": [
            {
              "id": 0,
              "parent_id": 0,
              "name": "string",
              "short_name": "string",
              "pinyin": "string",
              "sort": 0,
            }
        ]
    }
}

1.3 通用响应字段

1.3.1 状态字段

error_code: [int] 服务器状态码，0 为正常状态，异常状态待定。

error_message：[string] 错误信息，但 error_code 不为 0 时返回

1.3.2 数据字段

data: [object] 数据字段，所有响应数据都在此字段中

list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

page: [object] 分页信息，当返回数组数据时会携带该字段

current_page: [int] 当前页码，默认为1

total_page: [int] 总页数

page_size: [int] 每页数量：本项目常用page_size==10

示例

{
    error_code: 0,
    data: {
        key: value,
        list: [{
            key: value
        }],
        page {
        }
    }
}

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

sex:[int]

0: 未知
1: 男
2: 女

2.1.2打卡类型【v5.0修改】

type:[int]

1: 早餐
2: 午餐
3: 晚餐
4: 加餐
999: 体重打卡

2.2 核心结构

2.2.1 用户信息（6.0修改）

{
    id: 123,
    nick_name: '梦里花落知多少',
    real_name: '张三',
    phone: '15500000000',
    avatars: 'http://img1.imgtn.bdimg.com/it/u=3904886406,695848811&fm=11&gp=0.jpg',
    sex:0,
    brithday:'1999-10-10',
    height: 178,
    weight:180.5,
    real_weight:175,
    mac: 'xx:xx:xx',
    zero_coin:15,
    token:'aaaaaaa'
}

id: [int] 用户ID

nick_name: [string] 用户名

real_name: [string] 用户名，为空时表示未设置

phone: [string] 用户手机

avatars: [url] 头像

sex: [int] 性别，含义参见2.1

brithday: [date] 用户生日

height: [float] 身高

weight: [float] 体重

real_weight: [float] 当前体重，最仅一次的打卡体重

mac: [string] 硬件设备地址

zero_coin: [int] zerocoin数，上一次用户刷新后的结果

token: [string] token,用户登录态，仅登陆接口下发

2.2.2 打卡体重信息

{
    id: 123,
    weight: 56.00,
    clock_date: 2017-08-12,
    photo: 'http://img1.imgtn.bdimg.com/it/u=3904886406,695848811&fm=11&gp=0.jpg',
}

id: [int] 打卡ID

weight: [float] 体重

clock_date: [date] 打卡时间

photo: [url] 打卡体重图片

2.2.3 打卡信息（3.0修改）

{
    id: 123,
    type: 1,
    clock_date: 2017-08-12,
    photo: ['http://img1.imgtn.bdimg.com/it/u=3904886406,695848811&fm=11&gp=0.jpg'],
    photo_desc: '一个鸡蛋一杯豆浆',
    carbohydrate: 50.5,
    remark: "很好，继续加油",
    remark_time: "2017-08-12",
    up_vote: 15,
    down_vote:1,
    is_up:1,
    is_down:1,
    is_my:1,
}

id: [int] 打卡ID

type: [int] 打卡类型

clock_date: [date] 打卡时间

photo: [array] 打卡图片

photo_desc: [string] 图片描述

carbohydrate: [float] 碳水化合物重量单位g

remark: [string] 回复内容

remark_time: [date]回复时间

up_vote: [integer] 点赞数

down_vote: [integer] 踩数

is_up: [integer] 是否赞过登录后有此字断

is_down: [integer] 是否踩过登录后有此字断

is_my: [integer] 是否是我发布的，判断是否可删除操作

2.2.4 训练详情

{
    id: 123,
    name: "闪电7天减脂训练",
    price: 999.00,
    real_price: 999.00,
    photo: 'http://img1.imgtn.bdimg.com/it/u=3904886406,695848811&fm=11&gp=0.jpg',
    begin: 2017-05-01,
    end: 2017-06-01,
    people_count:0,
    content: ['http://img1.imgtn.bdimg.com/it/u=3904886406,695848811&fm=11&gp=0.jpg','http://img1.imgtn.bdimg.com/it/u=3904886406,695848811&fm=11&gp=0.jpg']
    publish_time:1111111111,
    join_status:0,
    training_status:1
}

id: [int] id

name: [string] 训练名称

price: [float] 价格

photo: [url] 主图，首页展示

training_begin: [date] 训练开始时间

training_end: [date] 训练结束时间

people_count: [int] 训练报名人数，0为不限制

content: [array] 内容图片

publish_time: [int] 发布时间

status: [int] 状态 1上线 0下线

join_status: [int] 0未参加 1已支付待填写表单 2已完成仅在详情接口中有

training_status:[int] 1可报名 2已满员 3正在进行 4活动结束 5未开始

2.2.5 申请表

{
    id: 123,
    user_training_id: 1,
    have_disease: 1,
    bodyfat: 13.5,
    selfie: "http://image.baidu.com/1.jpg",
    eating: 1,
    sport: 1
}

id: [int] id

user_training_id: [int] 用户加入训练的id

have_disease: [int] 是否有疾病 1有 0没有

bodyfat: [float] 体脂率浮点数，百分制

selfie: [url] 自拍照

eating: [int] 饮食习惯

sport: [int] 运动习惯

2.2.6 交易流水信息

注：支付完成后，请根据id向服务端获取支付状态，可能出现不同步情况

{
    id: 1,
    ord_id: "170831486775",
    amount: 1
}

id: [int] id

ord_id: [string] 订单号

amount: [int] 订单金额单位：分

2.2.7 生酮小贴士信息

{
    id: 1,
    title: "啤酒能喝出啤酒肚么",
    photo: 'http://img.jpg'
}

id: [int] id

title: [string] 标题

photo: [string] 图片

2.2.8 知识库信息

{
    id: 1,
    title: "卡路里",
    type: 1,
    tag: ['学生党', '减肥吃法'],
    content: '富文本',
}

id: [int] id

title: [string] 标题

type: [integer] 类型 '1'=>'咨询','2'=>'问答','3'=>'案例','4'=>'食谱'

tag: [array] 标签数组

content: [string] 内容

2.2.9 7日减脂营

{
    begin: "2018-03-11 12:12:12",
    now: "2018-03-13 12:12:12",
    share_time: "2018-03-13 12:12:12",
    hiit_list:{"2018-03-11":@燃脂数据, "2018-03-12":@燃脂数据, },
    clock_list:[{'type':1, 'clock_time':'2018-03-11 12:12:12'},{'type':1, 'clock_time':'2018-03-11 12:12:12'}]
    weight_change: 1,
}

begin: [string] 点击开启7日减脂营的时间

now: [string] 服务器当前时间，前端控制天数

share_time: [string] 分享的时间，如分享过有时间

hiit_list: [array] 燃脂的读数

clock_list: [array] 打卡记录，结构不是很合理，看前端需求

weight_change: [string] 体重变化 -1轻 0平 1重

2.2.10 燃脂数据信息【v6.0修改】

{
    ppm: 13.5,
    clock_time:'2018-03-11 12:12:12',
    sync_time:'2018-03-11 12:12:12',
}

ppm: [float] 燃脂指数

clock_time: [string] 吹气时间

sync_time: [string] 同步时间

2.2.11 训练营【V5.0新增】

{
    "id": 10,
    "join_begin": "2018-07-10",
    "training_begin": "2018-07-19",
    "watch_begin": "2018-07-11",
    "watch_end": "2018-07-19",
    "price": "669.00",
    "num": 100,
    "join_num":3
    "training_status": 4
}

id: [integer] id

join_begin: [string] 开始报名时间

training_begin: [string] 开营时间

watch_begin: [string] 围观奖励活动开始时间

wathc_end: [string] 围观奖励活动结束时间

price: [string] 价格

num: [integer] 训练营计划招募人数

join_num: [integer] 报名人数

training_status: [integer] 训练营状态 1未开始报名 2可报名 3报名结束 4训练营开始 5训练营结束

2.2.12 地址信息【V5.0新增】

{
    "province": "北京",
    "city": "北京市",
    "county": "朝阳区",
    "addr": "xxx1",
    "name": "李先生",
    "phone": "14412341234"  
}

province: [string] 省

city: [string] 市

county: [string] 县

addr: [string] 详细地址

name: [string] 收件人

phone: [string] 收件人电话

2.2.13 用户加入训练营信息【V5.0新增】

{
    "id": 1,
    "refund": "15.00",
    "watch_count":1,
    "open_watch": 0,
    "open_watch_time": "2018-03-03 12:22:22",
    "training_camp_info": @训练营信息
    "weight_loss": "3.5",
    "join_day": 3,
}

id: [integer] id 求围观时需要带上此id

refund: [string] 退还金额

watch_count: [integer] 围观总数

open_watch: [integer] 是否开启围观

open_watch_time: [string] 发起围观的时间

training_camp_info: [object] 用户加入的训练营信息

weight_loss: [string] 减下的体重

join_day: [integer] 加入的天数

2.2.14 围观信息【V5.0新增】

{
    "id": 1,
    "c_date": "2018-08-01",
    "content":"aaa",
    "user_info": @用户信息,
}

id: [integer] id

c_date: [string] 加油日期

content: [string] 加油内容

user_info: [object] 发送加油的用户

2.2.15 商品信息【V6.0新增】

{
    "id": 1,
    "name": "名称",
    "photo":"http://www.baidu.com/1.jpg",
    "href": 'http://www.baidu.com',
    "click_num": 3,
}

id: [integer] id

name: [string] 商品名称

photo: [string] 商品图片

href: [string] 链接地址

click_num: [integer] 点击数

2.2.16 排行用户信息【V6.0新增】

{
    "name": "名称",
    "photo":"http://www.baidu.com/1.jpg",
    "sort_num": 3,
}

name: [string] 名称
photo: [string] 头像
sort_num: [string] 排序数值，根据不通的排行榜，代表不通的含义

3、接口列表

3.1 用户类接口

3.1.1 小程序登陆平台接口（小程序）【v4.0修改】

请求URL

POST
/miniprogram/login

请求参数

session_token: open id

nick_name: 微信昵称

gender: 性别

city: 微信获取的城市

province: 微信获取的城市

county: 微信获取的区县

avatars: 用户头像

raw_data: wx.getUserInfo返回值

iv: wx.getUserInfo返回值

signature: wx.getUserInfo返回值

encrypted_data: wx.getUserInfo返回值

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

注：token为用户标识

3.1.2 添加个人信息接口【v6.0修改】

请求URL

POST
/user

请求参数

real_name: [string] 真是姓名【非必填】

phone: [string] 手机号码【必填】

verify_code: [string] 验证码【必填】

invite_phone: [string] 邀请人手机号【非必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.3 添加用户基础信息接口

请求URL

POST
/user/basic

请求参数

sex: 性别【必填】

birthday: 生日【必填】格式 1980-03-03

height: 身高【必填】

weight: 体重【必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.4 获取用户信息接口

请求URL

POST
/user/info

请求参数

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.5 小程序发送短信接口

注：小程序特殊处理

请求URL

POST
/miniprogram/verifycode

请求参数

phone: phone【必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.1.6 删除用户信息接口

请求URL

GET
/user/remove/{id}

3.1.7 加入班级

用户通过微信扫码打开特定的url，该url会类似于http://wechat.flashdiet.cn/class?id=2&date=2017-10-25&sign=62df89e619

请求URL

POST
/join/class

请求参数

token: token【必填】

id: 打开url上的参数【必填】

date: 打开url上的参数【必填】

sign: 打开url上的参数【必填】

{
    "error_code": 0,
    "data":{
        "join_status": 1, //join_status=1则是报名成功 2表示报名失败，二维码失效
        "message": "报名成功",
        "class":{        //join_status=1时，有class字段
            "id": 2,
            "name": "三年一班"
        }
    },
    "error_message": ""
}

3.1.8 修改个人信息接口（3.0新增）

请求URL

PUT
/user

请求参数

invite_phone: [string] 邀请人手机号【非必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.2 打卡类接口

3.2.1 提交最新体重接口【V6.0修改】

请求URL

POST
/user/weight

请求参数

weight: 体重数【必填】

photo: 体型图片【非必填】

datetime: 打卡时间，格式2017-10-10 10:10:10 【非必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @打卡体重信息
    },
    "error_message": ""
}

3.2.2 更新体重接口

注：非必填，提交什么修改什么

请求URL

POST
/user/weight/{weight_id}

请求参数

weight: 体重数【非必填】

photo: 体型图片【非必填】

datetime: 打卡时间，格式2017-10-10 10:10:10 【非必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @打卡体重信息
    },
    "error_message": ""
}

3.2.3 打卡接口【V5.0修改】

请求URL

POST
/clock

请求参数

type: 类型【必填】参考2.1.2

photo[]: 饮食图片地址,数组，最多四张【非必填】

photo_desc: 饮食描述【非必填】

carbohydrate: 饮食所含碳水化合物【非必填】

datetime: 打卡时间，格式2017-10-10 10:10:10 【非必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @打卡信息
    },
    "error_message": ""
}

3.2.4 更新打卡记录接口

请求URL

POST
/clock/{clock_id}

请求参数

photo[]: 饮食图片地址,数组，最多四张【必填】

photo_desc: 饮食描述【非必填】

carbohydrate: 饮食所含碳水化合物【非必填】

datetime: 打卡时间，格式2017-10-10 10:10:10 【非必填】

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @打卡信息
    },
    "error_message": ""
}

3.2.5 获取打卡记录接口

注：返回条数在1条至3条直接，左滑右滑
请求URL

post
/clock/info

请求参数

date: 日期请传时间戳，如不填写，则为当天日期【非必填】 ex：2017-08-30

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        [
            {
                "clock_date":'2017-08-30',
                "weight_info":@打卡体重信息,
                "clock_list":[//早中晚加，请根据type判断展示
                    @打卡记录
                ]
            }
        ]
    },
    "error_message": ""
}

3.2.6 打卡排行榜

请求URL

post
/clock/rank

请求参数

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
         "list":{
            [
                {
                    "user_info": @用户信息,
                    "weight_reduce": 10, //减肥总重量
                    "continue_clock": 14,//连续打卡天数
                    "weight_trends": 1,//减肥趋势 1上升 -1减轻 0稳定
                }
            ]
        },
    },
    "error_message": ""
}

3.3 训练接口

3.3.1 训练详情接口

请求URL

POST
/training/{training_id}

请求参数

token: token【必填】

响应

{
    "error_code": 0,
    "data":{
        @训练详情
    },
    "error_message": ""
}

3.3.2 训练列表接口

请求URL

POST
/training/list

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

token: token【非必填】

响应

{
    "error_code": 0,
    "data":{
        "list"=>[
            @训练详情
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

3.3.3 训练申请表填写

请求URL

POST
/training/question

请求参数

training_id: 训练的id【必填】

disease: 疾病情况【非必填】

bodyfat: 体脂率【非必填】

selfie: 自拍照【非必填】

eating: 饮食习惯【必填】答案从1开始

sport: 运动习惯【必填】答案从1开始

token: token【必填】

{
    "error_code": 0,
    "data":{
        @申请表
    },
    "error_message": ""
}

3.3.4 删除训练订单（测试环境使用）

请求URL

POST
/order/remove

请求参数

token: token【必填】

training_id: 训练id【必填】

{
    "error_code": 0,
    "msg": "",
    "data": {},
}

4 微信开发相关

4.1 微信小程序接口

4.1.1 微信小程序登陆接口

注：此接口有两种返回值,根据响应值的不同，做出相应的操作

请求URL

GET
/weixin/login

请求参数

code: 通过wx.login获取【必填】

响应
注：当用户第一次进入程序时，接口返回session_token，小程序将此值存入strorage。然后调用wx.getUserInfo（withCredentials需传true）后，调用过3.1.1接口获取用户token

{
    "error_code": 0,
    "data":{
        'session_token':'aaaa'
    },
    "error_message": ""
}

响应
注：当后台识别登陆用户后，直接返回用户信息（含token）

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

4.1.2 微信小程序下单接口

注：成功支付完成后，请根据trade结构中id调用4.1.3的接口向服务端获取支付状态
请求URL

POST
/miniprogram/place/order

请求参数

token: token【必填】

training_id: 训练id【必填】

{
    "error_code": 0,
    "data":{
        "config":{
            "appId": "wx79fdc8a58132d71e",
            "nonceStr": "59a81668a9fca",
            "package": "prepay_id=wx20170831220006cf41d65e040440830302",
            "signType": "MD5",
            "paySign": "01F29E28A80A2C620BE2C2113CDD8D7B",
            "timestamp": "1504188008"
        },
        trade":@交易流水信息
    },
    "error_message": ""
}

4.1.3 订单查询接口

请求URL

POST
/miniprogram/orderquery

请求参数

trade_id: 交易流水id 4.1.2接口返回trade信息中的id【必填】

token: token【必填】

{
    "error_code": 0,
    "data":{
        "result": 1, //0未支付（请继续轮训） 1支付成功 2支付失败
        "msg": "success" 
    },
    "error_message": ""
}

4.2 微信服务号接口

4.2.1 微信下单接口

请求URL

POST
/weixin/place/order

请求参数

token: token【必填】

training_id: 训练id【必填】

响应

{
    "error_code": 0,
    "data":{
        "jsConfig":{
            "debug": true,
            "beta": false,
            "appId": "wxec9f72c6529c6cd6",
            "nonceStr": "Fhglo9Vf12",
            "timestamp": 1491621038,
            "url": "http://local.api.project.com/api/v1/weixin/place/order",
            "signature": "9b4ef2b2153590ca9d738b4a481c0bae677391b1",
            "jsApiList":[
                "onMenuShareQQ",
                "onMenuShareWeibo",
                "chooseWXPay"
            ]
        },
        "payConfig":{
            "appId": "wxec9f72c6529c6cd6",
            "nonceStr": "58e854aec0d8c",
            "package": "prepay_id=wx2017040811100055b9f33d1c0980809479",
            "signType": "MD5",
            "paySign": "B84C9BEA96B3F60B800C45BC52ADE7A8",
            "timestamp": "1491621038"
        }
    },
    "error_message": ""
}

使用方式（仅供参考）：

wx.config(result.data.jsConfig);
wx.ready(function(){
    wx.chooseWXPay({
        timestamp: result.data.payConfig.timestamp,
        nonceStr: result.data.payConfig.nonceStr,
        package: result.data.payConfig.package,
        signType: result.data.payConfig.signType,
        paySign: result.data.payConfig.paySign,
        success: function (res) {
            alert('成功');
        },
        fail:function(res)
        {
            alert('fail');
        },
        complete:function(res)
        {
            alert('complete');
        }
    });
});

4.2.2 订单查询接口

请求URL

POST
/wechat/orderquery

请求参数

trade_id: 交易流水id 4.1.2接口返回trade信息中的id【必填】

token: token【必填】

{
    "error_code": 0,
    "data":{
        "result": 1, //0未支付（请继续轮训） 1支付成功 2支付失败
        "msg": "success" 
    },
    "error_message": ""
}

微信JS-SDK： https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1445241432&token=&lang=zh_CN

微信服务号支付服务端接口： https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=1_1

微信小程序登陆文档：
https://mp.weixin.qq.com/debug/wxadoc/dev/api/api-login.html#wxchecksessionobject

微信小程序支付文档：
https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_3&index=1

5 3.0版本接口

5.1 生酮小贴士

5.1.1 生酮小贴士详情接口

请求URL

GET
/note/{id}

请求参数

id: 小贴士id

{
    "error_code": 0,
    "data":{
        @生酮小贴士信息
    },
    "error_message": ""
}

5.1.2 下一个生酮小贴士接口

请求URL

GET
/note/{id}/{direction}

请求参数

id: 小贴士id

direction: 方向左滑右滑分别传left，right

{
    "error_code": 0,
    "data":{
        @生酮小贴士信息
    },
    "error_message": ""
}

5.1.3 生酮小贴士详情（最近的3个）接口

请求URL

GET
/note/{id}/near

请求参数

id: 小贴士id

{
    "error_code": 0,
    "data":{
        "pre":@生酮小贴士信息,
        "left":@生酮小贴士信息,
        "right":@生酮小贴士信息,
    },
    "error_message": ""
}

5.1.4 全部生酮小贴士接口

请求URL

GET
/note/all

请求参数

id: 小贴士id

{
    "error_code": 0,
    "data":{
        "list":[@生酮小贴士信息],
    },
    "error_message": ""
}

5.2 知识库

5.2.1 知识库士详情接口

请求URL

GET
/knowledge/{id}

请求参数

id: 知识id

{
    "error_code": 0,
    "data":{
        @知识库信息
    },
    "error_message": ""
}

5.2.2 知识库士列表接口

请求URL

GET
/knowledge/list

请求参数

{
    "error_code": 0,
    "data":{
        list:[
            @知识库信息
        ]
    },
    "error_message": ""
}

5.3 生酮美食接口

5.3.1 发布美食接口【同3.2.3】

参考3.2.3

5.3.2 生酮美食列表接口

请求URL

POST
/clock/list

请求参数

sort: 排序时间排序:default 点赞数:up 踩数:down

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

token: token

{
    "error_code": 0,
    "data":{
        "list"=>[
            @打卡信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

5.3.3 生酮美食详情接口

请求URL

POST
/clock/{id}/info

请求参数

id: 打卡id

token: token

{
    "error_code": 0,
    "data":{
            @打卡信息
    },
    "error_message": ""
}

5.3.4 生酮美食（点赞|踩）接口

请求URL

POST
/clock/{id}/vote

请求参数

id: 打卡id

type: 赞、踩分区传up和down

token: token

{
    "error_code": 0,
    "data":{
            @打卡信息
    },
    "error_message": ""
}

5.3.5 取消生酮美食（点赞|踩）接口

请求URL

POST
/clock/{id}/cancel/vote

请求参数

id: 打卡id

type: 赞、踩分区传up和down

token: token

{
    "error_code": 0,
    "data":{
            @打卡信息
    },
    "error_message": ""
}

5.3.6 生酮美食接口（首页随机6个）

请求URL

POST
/clock/rand/list

请求参数

token: token

{
    "error_code": 0,
    "data":{
        "list"=>[
            @打卡信息
        ],
    },
    "error_message": ""
}

5.3.7 我的生酮美食接口

请求URL

POST
/clock/my

请求参数

sort: 排序时间排序:default 点赞数:up 踩数:down

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

token: token

{
    "error_code": 0,
    "data":{
        "list"=>[
            @打卡信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

5.3.8 删除生酮美食接口

请求URL

DELETE
/clock/{id}/del

请求参数

id: 打卡id

token: token

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.4 7日减脂营

5.4.1 开启7日减脂营

请求URL

POST
/hiit/start

请求参数

token: token

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.4.2 获取7日减脂营数据

请求URL

POST
/hiit

请求参数

token: token

{
    "error_code": 0,
    "data":{
        @7日减脂营信息
    },
    "error_message": ""
}

5.4.3 7日减脂营数据打卡

请求URL

POST
/hiit/clock

请求参数

type: 类型【必填】参考2.1.2

token: token

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.4.4 7日减脂营体重最终结果

请求URL

POST
/hiit/weight

请求参数

change: 体重变化【必填】-1轻 0平 1重

token: token

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.4.5 分享7日减脂营

请求URL

POST
/hiit/share

请求参数

token: token

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.4.6 提交模板消息form id

请求URL

POST
/hiit/form/id

请求参数

token: token

form_id: form id

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.5 首页接口

5.5.1 首页接口

请求URL

POST
/index/v3

请求参数

token: token

//硬件相关待完善

{
    "error_code": 0,
    "data":{
        'note': @小贴士信息,
        'is_open_hiit': 1, //是否开通7日燃脂训练营
        'clock_list':[@打卡信息],
        'hiit_info':@燃脂数据信息,
    },
    "error_message": ""
}

5.5.2 改版后首页接口

请求URL

POST
/index/v4

请求参数

token: token

//硬件相关待完善

{
    "error_code": 0,
    "data":{
        'banner': [@广告信息],
        'date': "2018-04-17", 
        'time': "23:30:30",
        'weight':@打卡体重信息,
    },
    "error_message": ""
}

5.6 硬件设备

5.6.1 硬件上传数据

请求URL

POST
/device

请求参数

token: token

data: 硬件数据 json串格式[{'date':'2018-03-25 18:00:00', 'mmol':13.5},{'date':'2018-03-26 21:00:00', 'mmol':23.5},]

//硬件相关待完善

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

~~#### 5.6.2 获取燃脂数据~~
请求URL

POST
/device/month/data

请求参数

token: token

month: 月份 2018-03

//硬件相关待完善

{
    "error_code": 0,
    "data":{
        "history":[
            @燃脂数据信息
        ],//明细，多少次上传记录多少次
        "list":[
            @燃脂数据信息
        ], //每日只取最后一条
        "weight":[
            @打卡体重信息
        ],
    },
    "error_message": ""
}

5.6.3 获取最近一周燃脂数据

请求URL

POST
/device/week/data

请求参数

token: token

//硬件相关待完善

{
    "error_code": 0,
    "data":{
        "history":[
            @燃脂数据信息
        ],//明细，多少次上传记录多少次
        "list":[
            @燃脂数据信息
        ], //每日只取最后一条
        "weight":[
            @打卡体重信息
        ],
    },
    "error_message": ""
}

6 5.0版本接口【V5.0新增】

6.1 活动接口

6.1.1 首页数据接口

立即加入 报名成功（未开始围观） 生酮营在进行中 减脂曲线
请求URL

POST
/index/v5

请求参数

token: token

首页的状态比较多结构比较复杂立即加入的状态

{
    "error_code": 0,
    "data":{
        "index_type":1, #index_type=1表示用户未加入
        "training_camp_list": [@训练营]
        "have_coupon":0, #是否有减100的优惠券 0无 1有
        "user_info":@用户信息  #可用于后续报名流程判断是否实名
        "user_addr":@地址信息
    },
    "error_message": ""
}

首页的状态比较多结构比较复杂报名成功（未开始围观）

{
    "error_code": 0,
    "data":{
        "index_type":2, #index_type=2表示用户加入，但是围观未开始
        "user_camp_info": @用户训练营信息
        "user_addr":@地址信息
    },
    "error_message": ""
}

首页的状态比较多结构比较复杂报名成功（围观已开始）

{
    "error_code": 0,
    "data":{
        "index_type":3, #index_type=3表示用户加入，围观已开始
        "user_camp_info": @用户训练营信息
        "user_addr":@地址信息
    },
    "error_message": ""
}

首页的状态比较多结构比较复杂报名成功（训练营已开始，前7天）

{
    "error_code": 0,
    "data":{
        "index_type":4, #index_type=3表示用户加入，围观已开始
        "user_camp_info": @用户训练营信息,
        "user_addr":@地址信息,
        "have_msg": 1,围观红点  1有 0无  
        "have_gift": 1,任务红点 1有 0无
        "receive_welfare": 2,领取福利， 0无领取资格，1有资格未领取 2已领取
        "clock_day": ["2018-08-04","2018-08-05",], //按日期排序数组，从训练开始～当前日的日期，可用于第一天、第二天、第三天等，有的日期表示已解锁，
        "clock_info": { //map结构，key为日期，与clock_day对应，value是已排序好的数组
            "2018-08-04":[],  //如果当天没有打卡，则数据为空
            "2018-08-05":[
                {
                    "type":1, //参考2.1.2
                    "created_at":'2018-08-05 12:12:12',//打卡时间
                    "data":@打卡体重信息 or @打卡信息， 不同的type结构不同 
                }
            ],
        },
    },
    "error_message": ""
}

首页的状态比较多结构比较复杂报名成功（训练营已开始，第8天）

{
    "error_code": 0,
    "data":{
        "index_type":5, #index_type=3表示用户加入，围观已开始
        "user_camp_info": @用户训练营信息,
        "user_addr":@地址信息,
        "user_info": @用户信息 
        "weight_begin": 第一天第体重
        "weight_end": 最后一天第体重
        "weight_loss": 减少的体重 // 您在MISSZERO7天减脂营体重从100公斤
变到90公斤，共减脂10公斤！
        "weight_change": [120，119，118，-1，-1，-1，-1], //长度为7的数组，-1表示当天没有值
    },
    "error_message": ""
}

6.1.2 活动报名支付接口

请求URL

POST
/training-camp/{id}/join

请求参数

token: token【必填】

id: 训练id【必填】

{
    "error_code": 0,
    "data":{
        "config":{
            "appId": "wx79fdc8a58132d71e",
            "nonceStr": "59a81668a9fca",
            "package": "prepay_id=wx20170831220006cf41d65e040440830302",
            "signType": "MD5",
            "paySign": "01F29E28A80A2C620BE2C2113CDD8D7B",
            "timestamp": "1504188008"
        },
        trade":@交易流水信息
    },
    "error_message": ""
}

6.1.3 活动报名支付结果轮训接口

6.1.4 减脂路径图片生产接口

请求URL

POST
/training/path/img

请求参数

token: token【必填】

image_url: 前端生成对的png图片的链接【必填】

{
    "error_code": 0,
    "data":{
        "url":'http://img", //
    },
    "error_message": ""
}

6.1.5 今日任务完成情况接口

含礼物领取情况
请求URL

POST
/today/job

请求参数

token: token【必填】

{
    "error_code": 0,
    "data":{
        "points":100, //积分
        "job_list":[1,0,1,1,9], //分别代表体重打卡，早中晚打卡和好友鼓励， 前四个1表示完成 0表示未完成，好友鼓励是鼓励总数，大于等于10表示完成
        "get_gift": [0,1,0],//分别表示是否点击礼物，40分 150分和400分
    },
    "error_message": ""
}

6.1.6 点击礼物领取接口

请求URL

POST
/receive/gift

请求参数

token: token【必填】

type: 礼物级别【必填】 1表示40积分 2表示150积分 3表示400积分

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.1.7 群减重排行接口

请求URL

POST
/weight/loss/rank

请求参数

token: token【必填】

code: wx.login()获取的code

encrypted_data: 微信回调获取

iv: 微信回调获取

{
    "error_code": 0,
    "data":{
        "list":[
            {
                user_info:@用户信息
                weight_loss: 15,
            }
        ]
    },
    "error_message": ""
}

6.1.8 群鼓励|围观排行接口

请求URL

POST
/hearten/rank

请求参数

token: token【必填】

code: wx.login()获取的code

encrypted_data: 微信回调获取

iv: 微信回调获取

{
    "error_code": 0,
    "data":{
        "list":[
            {
                user_info:@用户信息
                hearten: 15,  //鼓励数
            }
        ]
    },
    "error_message": ""
}

6.1.9 群打卡列表接口

请求URL

POST
/group/clock/info

请求参数

token: token【必填】

code: wx.login()获取的code

encrypted_data: 微信回调获取

iv: 微信回调获取

{
    "error_code": 0,
    "data":{
        "list":[
            {
                user_info:@用户信息
                clock_info: [0,1,1,1],  //体重 早餐 午餐 晚餐 0未打卡 1已打卡
            }
        ]
    },
    "error_message": ""
}

6.1.10 减脂路径数据

请求URL

POST
/training/path

请求参数

token: token

{
    "error_code": 0,
    "data":{
        "user_info": @用户信息 
        "weight_begin": 第一天第体重
        "weight_end": 最后一天第体重
        "weight_loss": 减少的体重 // 您在MISSZERO7天减脂营体重从100公斤
变到90公斤，共减脂10公斤！
        "weight_change": [120，119，118，-1，-1，-1，-1], //长度为7的数组，-1表示当天没有值
    },
    "error_message": ""
}

6.1.11 领取福利接口

请求URL

POST
/receive/welfare

请求参数

token: token【必填】

id: 首页接口中user_camp_info结构中的id【必填】

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.2 分享接口

6.2.1 分享围观活动回调接口

请求URL

POST
/watch/callback

请求参数

token: token【必填】

id: 首页接口中user_camp_info结构中的id【必填】

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.2.2 是否存在围观接口

请求URL

POST
/is/watch

请求参数

token: token【必填】

id: 首页接口中user_camp_info结构中的id【必填】

{
    "error_code": 0,
    "data":{
        "type":0, //type=0表示没有围观， type=1表示已经围观了其它用户
    },
    "error_message": ""
}

6.2.3 围观接口

请求URL

POST
/watch

请求参数

token: token【必填】

id: 首页接口中user_camp_info结构中的id【必填】

//此接口有两种状态，1、送优惠券 type=0 2、不送优惠券 type=1

{
    "error_code": 0,
    "data":{
        "type":0, //type=0表示围观成功，送优惠券， type=1表示围观成功，不送优惠券，
    },
    "error_message": ""
}

6.2.4 添加收货地址接口

请求URL

POST
/user-addr

请求参数

token: token [必填]

province: 省 [必填]

city: 市 [必填]

county: 区县 [必填]

name: 收件人 [必填]

phone: 收件人电话 [必填]

{
    "error_code": 0,
    "data":{
        @地址信息
    },
    "error_message": ""
}

6.2.5 获取收货地址接口

请求URL

POST
/user-addr/info

请求参数

token: token [必填]

{
    "error_code": 0,
    "data":{
        @地址信息
    },
    "error_message": ""
}

6.2.6 修改收货地址接口

请求URL

PUT
/user-addr

请求参数

token: token [必填]

province: 省 [必填]

city: 市 [必填]

county: 区县 [必填]

name: 收件人 [必填]

phone: 收件人电话 [必填]

{
    "error_code": 0,
    "data":{
        @地址信息
    },
    "error_message": ""
}

6.3 围观接口

6.3.1 我的围观接口

请求URL

POST
/my/watch

请求参数

token: token【必填】

//如果data为空，表示还没围观任何人，如果data中不存在watch_msg，则表示当天没有发送消息

{
    "error_code": 0,
    "data":{
        "be_watch": @用户信息
        "watch_msg": @围观消息  //当天已发送消息 就有此字段
        "user_camp_info": @用户加入训练营的信息
    },
    "error_message": ""
}

6.3.2 围观加油接口

请求URL

POST
/watch-msg

请求参数

token: token【必填】

content: 加油内容【必填】

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.3.2 好友围观接口

请求URL

POST
/watch-msg/list

请求参数

token: token【必填】

{
    "error_code": 0,
    "data":{
        "list":{
            "2018-08-01":[
                @围观信息
            ],
            "2018-07-31":[
                @围观信息
            ],
        }
    },
    "error_message": ""
}

7 6.0版本接口

7.1 硬件接口

7.1.1 硬件绑定接口

请求URL

POST
/device/bind

请求参数

token: token【必填】

mac: 设备id【必填】

{
    "error_code": 0,
    "data":{
        'is_first':1//设备是否第一次绑定1是 0否
    },
    "error_message": ""
}

7.1.2 硬件上传数据

请求URL

POST
/device

请求参数

token: token

data: 硬件数据 json串格式[{"date":"2018-09-17 18:00:00", "ppm":13.5},{"date":"2018-09-18 21:00:00", "ppm":23.5}]

//硬件相关待完善

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

7.1.3 硬件解绑接口

请求URL

POST
/device/unbind

请求参数

token: token【必填】

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

7.2 活动接口

7.2.1 首页接口

请求URL

POST
/index/v6

请求参数

token: token

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

7.2.2 点击商品接口

请求URL

get
/goods/click/{id}

请求参数

id: 商品id

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

7.2.3 当日ppm数据信息

请求URL

POST
/ppm/day

请求参数

token: token

{
    "error_code": 0,
    "data":{
        "ppm_list":[
            @燃脂数据信息
        ]
    },
    "error_message": ""
}

7.2.4 获取最近7日燃脂和体重数据

请求URL

POST
/device/week

请求参数

token: token

{
    "error_code": 0,
    "data":{
        "ppm_list":[
            @燃脂数据信息
        ], 
        "weight_list":[
            @打卡体重信息
        ],
    },
    "error_message": ""
}

7.2.5 获取某月燃脂数据

请求URL

POST
/device/month/data

请求参数

token: token

month: 月份 2018-03

{
    "error_code": 0,
    "data":{
        "history":[
            @燃脂数据信息
        ],//明细，多少次上传记录多少次
        "ppm_list":[
            @燃脂数据信息
        ], 
        "weight_list":[
            @打卡体重信息
        ], 
    },
    "error_message": ""
}

7.2.6 获取某月燃脂数据【合并至7.2.5】

请求URL

POST
/device/month/weight

请求参数

token: token

month: 月份 2018-03

{
    "error_code": 0,
    "data":{
        "weight_list":[
            @打卡体重信息
        ], 
    },
    "error_message": ""
}

7.2.7 获取用户最新的zero币数据

请求URL

POST
/user/zerocoin

请求参数

token: token

{
    "error_code": 0,
    "data":{
        "weight_list":100, 
    },
    "error_message": ""
}

7.2.8 昨日ppm排行榜

请求URL

GET
/rank/ppm/yesterday

请求参数

{
    "error_code": 0,
    "data":{
        [
            @排行用户信息
        ]
    },
    "error_message": ""
}

7.2.9 7日ppm排行榜

请求URL

GET
/rank/ppm/week

请求参数

{
    "error_code": 0,
    "data":{
        [
            @排行用户信息
        ]
    },
    "error_message": ""
}

7.2.10 昨日减重排行榜

请求URL

GET
/rank/weight/yesterday

请求参数

{
    "error_code": 0,
    "data":{
        [
            @排行用户信息
        ]
    },
    "error_message": ""
}

7.2.11 7日减重排行榜

请求URL

GET
/rank/weight/week

请求参数

{
    "error_code": 0,
    "data":{
        [
            @排行用户信息
        ]
    },
    "error_message": ""
}

闪电产品端1.0 微信端 接口文档

1、项目约定

1.1 基本约定

1.1.1 API Base Url

1.1.2 鉴权字段(身份标识)

1.1.3 HTTP请求中字段要求

1.1.4 图片裁图规则

1.2 通用接口

1.2.1 通用接口URL

1.2.2 上传图片

1.2.3 验证码图片

1.2.4 发送短信

1.2.5 城市列表接口【v4.0新增】

1.2.6 城市下区域接口 【v4.0新增】

1.3 通用响应字段

1.3.1 状态字段

1.3.2 数据字段

1.3.3 分页字段

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

2.1.2打卡类型 【v5.0修改】

2.2 核心结构

2.2.1 用户信息 （6.0修改）

2.2.2 打卡体重信息

2.2.3 打卡信息 （3.0修改）

2.2.4 训练详情

2.2.5 申请表

2.2.6 交易流水信息

2.2.7 生酮小贴士信息

2.2.8 知识库信息

2.2.9 7日减脂营

2.2.10 燃脂数据信息 【v6.0修改】

2.2.11 训练营 【V5.0新增】

2.2.12 地址信息 【V5.0新增】

2.2.13 用户加入训练营信息【V5.0新增】

2.2.14 围观信息【V5.0新增】

2.2.15 商品信息【V6.0新增】

2.2.16 排行用户信息【V6.0新增】

3、接口列表

3.1 用户类接口

3.1.1 小程序登陆平台接口（小程序）【v4.0修改】

3.1.2 添加个人信息接口 【v6.0修改】

3.1.3 添加用户基础信息接口

3.1.4 获取用户信息接口

3.1.5 小程序发送短信接口

3.1.6 删除用户信息接口

3.1.7 加入班级

3.1.8 修改个人信息接口（3.0新增）

3.2 打卡类接口

3.2.1 提交最新体重接口【V6.0修改】

3.2.2 更新体重接口

3.2.3 打卡接口【V5.0修改】

3.2.4 更新打卡记录接口

3.2.5 获取打卡记录接口

3.2.6 打卡排行榜

3.3 训练接口

3.3.1 训练详情接口

3.3.2 训练列表接口

3.3.3 训练申请表填写

3.3.4 删除训练订单（测试环境使用）

4 微信开发相关

4.1 微信小程序接口

4.1.1 微信小程序登陆接口

4.1.2 微信小程序下单接口

4.1.3 订单查询接口

4.2 微信服务号接口

4.2.1 微信下单接口

4.2.2 订单查询接口

5 3.0版本接口

5.1 生酮小贴士

5.1.1 生酮小贴士详情接口

5.1.2 下一个生酮小贴士接口

5.1.3 生酮小贴士详情（最近的3个）接口

5.1.4 全部生酮小贴士接口

5.2 知识库

5.2.1 知识库士详情接口

5.2.2 知识库士列表接口

5.3 生酮美食接口

5.3.1 发布美食接口【同3.2.3】

闪电产品端1.0 微信端接口文档

1.2.6 城市下区域接口【v4.0新增】

2.1.2打卡类型【v5.0修改】

2.2.1 用户信息（6.0修改）

2.2.3 打卡信息（3.0修改）

2.2.10 燃脂数据信息【v6.0修改】

2.2.11 训练营【V5.0新增】

2.2.12 地址信息【V5.0新增】

3.1.2 添加个人信息接口【v6.0修改】

6 5.0版本接口【V5.0新增】

7.2.6 获取某月燃脂数据【合并至7.2.5】