NICE-Cube文档

未分类

注册（register）

用以创建关联用户，并返回访问凭证。

请求

语法

POST /api/v1/authorizations/register

访问权限

签名

请求参数

生成 sign 的必要参数

响应内容

• 请求成功

{ 
    "token": "token" 
}

• 请求失败

{ 
    "errors": 
    { 
        "code": 600, 
        "message": "authenticate parameters failed" 
    }
}

error code

获取凭证（credential）

该接口用来获取访问凭证（token），获取的凭证将用以访问其他数据接口

请求

语法

GET /api/v1/authorizations/credential

访问权限

签名

请求参数

生成 sign 的必要参数

响应内容

• 请求成功

{ 
    "token": "token" 
}

• 请求失败

{ 
    "errors": 
    { 
        "code": 600, 
        "message": "authenticate parameters failed" 
    }
}

error code

签名生成算法

1. 首先把参数以json的形式组成，例如：

params_json = {
    channel: 'ali',
    uid: 'uid01',
    deadline: 1472035567
}

1. 对JSON编码的参数进行URL安全的Base64编码

encoded_params = Base64.urlsafe_encode64(params_json.to_json)
# 编码后的值为： 'eyJjaGFubmVsIjoiYWxpIiwidWlkIjoidWlkMDEiLCJkZWFkbGluZSI6MTQ3MjAzNTU2N30='

1. 使用 secret_key 给上一步生成的字符串计算 HMAC-SHA1 签名

# 先把 app_key 和 encoded_params 拼接起来： app_key + encoded_params
# 然后对其进行签名
init_sign = hmac_sha1(secret_key, app_key + encoded_params)
# 签名之后的值：'<\xD8\x8A\n<~\xF7\xF6.W\xB7\xBCm\bts\xFE((\xCA'

1. 对签名进行URL安全的Base64编码

encoded_sign = Base64.urlsafe_encode64(init_sign)
# 编码后的值为：'PNiKCjx-9_YuV7e8bQh0c_4oKMo='

1. 最后把 app_key, encoded_sign, encoded_params 拼接起来，生成最终的签名结果

# app_key + ':' + encoded_sign + ':' + 'encoded_params'
sign = 'APP_KEY:PNiKCjx-9_YuV7e8bQh0c_4oKMo=:eyJjaGFubmVsIjoiYWxpIiwidWlkIjoidWlkMDEiLCJkZWFkbGluZSI6MTQ3MjAzNTU2N30='

请注意其中的 deadline 参数，此签名只在该有效期之前有效。

上传用户信息（profiles）

用以上传或修改用户资料（身高，体重，性别等信息）

请求

语法

POST /api/v1/profiles

访问权限

访问凭证

请求参数

diseases value

diseases 如果有多个则用 ',' 隔开，例子： "1,3,6"

响应内容

• 请求成功

{ }

• 请求失败

{ 
    "errors": 
    { 
        "code": 610, 
        "message": "invalid token" 
    }
}

获取饮食计划（user_diets）

用以获取一周的饮食计划信息，这里的一周指从当前周的起始（周日）到当前周的结束（周六）共七天

请求

语法

GET /api/v1/user_diets

访问权限

访问凭证

请求参数

响应内容

• 请求成功

{
    "data": [
        {
            "date": "2016-08-28",
            "menu": [
                {
                    "set_type": "breakfast",
                    "details": [
                        {
                            "name": "国光苹果",
                            "amount": 2,
                            "unit": "个",
                            "image_url": "http://7xrnmu.com1.z0.glb.clouddn.com/house/food_mid/m_guoguangpingguo.jpg",
                            "code": "guoguangpingguo",
                            "calory": 168,
                            "unit_id": 152
                        },
                        {
                            "name": "牛奶",
                            "amount": 1,
                            "unit": "杯",
                            "image_url": "http://7xrnmu.com1.z0.glb.clouddn.com/house/food_mid/m_1160989087812.jpg",
                            "code": "niuru_junzhi",
                            "calory": 108,
                            "unit_id": 150
                        }
                    ],
                    "calory": 276
                },
                {
                    "set_type": "lunch",
                    "details": [
                        {...}
                    ],
                    "calory": 454
                },
                {
                    "set_type": "extra_meal",
                    "details": [
                        {...}
                    ],
                    "calory": 144
                },
                {
                    "set_type": "dinner",
                    "details": [
                        {...}
                    ],
                    "calory": 332
                }
            ]
        },
        {
            "date": "2016-08-29",
            "menu": [...]
        },
        {
            "date": "2016-08-30",
            "menu": [...]
        },
        {
            "date": "2016-08-31",
            "menu": [...]
        },
        {
            "date": "2016-09-01",
            "menu": [...]
        },
        {
            "date": "2016-09-02",
            "menu": [...]
        },
        {
            "date": "2016-09-03",
            "menu": [...]
        }
    ]
}

响应结构解释

上面示例结构中重复部分均略写，以 '...' 代写

• 请求失败

{ 
    "errors": 
    { 
        "code": 610, 
        "message": "invalid token" 
    }
}

食物搜索（search）

用以根据关键字搜索食物，返回简要数据列表

请求

语法

POST(GET) /api/v1/foods/search

访问权限

访问凭证

请求参数

响应内容

• 请求成功

{
    "page": 1,
    "total_pages": 257,
    "foods": [
        {
            "id": 469,
            "code": "pingguo_junzhi",
            "name": "苹果",
            "thumb_image_url": "http://s.boohee.cn/house/food_mid/mid_photo_2015126214658469.jpg",
            "is_liquid": false,
            "health_light": 1,
            "weight": "100",
            "calory": "54"
        },
        {
            "id": 481,
            "code": "qingxiangjiaopingguo",
            "name": "青香蕉苹果",
            "thumb_image_url": "http://s.boohee.cn/house/food_mid/mid_photo_20152493717481.jpg",
            "is_liquid": false,
            "health_light": 1,
            "weight": "100",
            "calory": "52"
        },
        ...
        {
            "id": 501,
            "code": "pingguoli",
            "name": "苹果梨",
            "thumb_image_url": "http://s.boohee.cn/house/food_mid/m_pingguoli.jpg",
            "is_liquid": false,
            "health_light": 1,
            "weight": "100",
            "calory": "53"
        }
    ]
}

• 如果请求结果为空

{
  page: 1,
  total_pages: 0,
  items: []
}

响应结构解释