SmartShop设计文档

SmartShop

说明：
1. 手机端推送服务使用极光推送，具体使用说明请参考极光推送文档。
2. 手机端用户登陆之后，请将用户的user_id设置为极光推送的别名alias，tag设置为user，以供服务器推送消息
3. 所有用户登陆之后，服务器返回json数据包含一个token字段，请妥善保存此字段，在以后的每一个POST和GET请求中务必包含token字段用于用户身份标识,token是有有效期限的，过期会返回token invalid

数据库设计文档

戳我

商家端API

戳我

用户端API

说明：返回数据格式均为json，编码均为utf-8

不需要登陆的：

1.1 获取商品价格

• 地址 /api/v1/getgoodprice/
• 方法为 GET
• 必选参数：qcode商品条形码, busi_id 商家id
• 例如：/api/v1/getgoodprice?qcode=**&busi_id=**
  即需要提供qcode条形码和business商家id的值。返回json数据格式，例如

{"state": "OK", "good_des": "Flask入门", "qcode": "9787115373991", "price": 59.0, "good_name": "FlaskWeb开发"}

注册

2.1　用户注册

• 地址：　/api/v1/userregister/
• 方法：POST
• 必选参数：　user_id, user_password
• 可选参数: user_name, user_email, user_sex, user_age, user_tel, user_address
• 返回数据

{
    "state": ["tel error","email error"]
}

state有 OK, id register, password short, email error, tel error, age error

注: user_age格式为 YYYYMMDD,例如20150102
user_sex必须为male或者female
用户注册密码最少6位

以下需要登陆才能查看

token字段如果没说明就是我忘记说明了,但是请求也得加上

2.2 登陆

• 地址　/api/v1/userlogin/
• 方法　POST,　
• 必选参数　user_id,用户登陆id,，user_password，用户登陆密码
• 例如：
  POST 为　user_id = test, user_password = test;
  返回　

{"token": "011a326ee17112b6c4171e474045b462", "state": "OK"}

State 有 OK，password error, userid error
用户登陆之后会返回一个token，请妥善保存此token，当需要登陆权限才能申请的数据时，如果时GET方法请带此token，POST方法也一样带上

2.3 用户信息更新

• 地址　/api/v1/userupdate
• 方法　POST
• 必选参数：token
• 可选参数：user_password, user_name, user_email, user_sex, user_age, user_tel, user_address
• 返回数据

{
    "state": ["tel error","email error"]
}

可用此方法更改密码，修改姓名，电话等
state有 OK, id register, password short, email error, tel error, age error

2.4 获取用户信息

• 地址　/api/v1/getuserinfo
• 方法　GET,
• 必选参数：token
• 返回数据

{"state": "OK", "user_email": "", 
"user_age": "20160308", "user_address": "", 
"user_name": "", "user_tel": "", 
"user_sex": "", "user_id": "testuser", 
"user_register": "20151212121212"}

具体字段说明详见数据库设计文档
state有not login,OK

3.1 添加到购物车

• 地址　/api/v1/addcart/
• 方法：　POST
• 必选参数: token　商家id, qcode　商品条形码，token
• 可选参数，num　商品数量，不填为１
• 例如：
  POST为　busi_id = "13465", qcode = “13246";
  返回

｛"state": "OK"}

如果购物车已有，那么数量会加num
State 有　OK，not login, error, num error,token invalid, shortage代表商品不足,无法添加

3.2 删除购物车

• 地址　/api/v1/delcart/
• 方法：　POST
• 必选参数: busi_id　商家id, qcode　商品条形码,token
• 例如：
  POST为　busi_id = "13465", qcode = “13246", token="asdf455a4df";
  返回　

｛　"state": "OK"}

State 有　OK，not login, error

3.3修改购物车

1. 地址　/api/v1/changecart/
2. 方法：　POST　
3. 必选参数 busi_id　商家id, qcode　商品条形码， 数量 num, token
4. 例如：
   POST为　busi_id = "13465", qcode = “13246", num=5
   返回　

｛"state": "OK"}

State 有　OK，not login, error, shortage代表商品不足,无法添加

注：修改购物车，只能修改商品数目，且必须大于0
如果购物车不存在这样的商品,则返回error

3.4 查看购物车

1. 地址: /api/v1/getcart/
2. 方法：GET　
3. 必选参数: busi_id商家id, token
4. 例如：/api/v1/getcart/?bussiness_id=3465&token=asdfadf

{"state": "OK", "cart": 
    [
        {"good_des": "红旗渠银河之光", "total_price": 10.0,        "good_name": "红旗渠银河之光", "price": 5.0, 
        "qcode": "6901028164542", "num": 1.0}
    ]
}

* 如想获得所有商品总价，还需自己计算

4.1　提交订单

提交订单前，　必须保证本地购物车数据和云端数据库一致。

1. 地址： /api/v1/submitorder/
2. 方法：　POST
3. 必选参数：　busi_id 商家id, token
4. 可选参数：　address用户订单编号送货地址
5. 例如：
   POST 为 busi_id = 1346, token = 'adfadfasdf'
   返回数据

{"state": "OK", "order_id": 201508159366}

state，状态说明，有 not login, error

• 关于提交订单的说明：
  
  • 不提供在购物车以多选模式提交订单，而是直接提交整个购物车。
  • 用户可以在购车车进行增删查改操作，之后再提交整个购物车，即提交订单。
  • 为什么呢？个人的一些看法：
  • 首先，肯定这样对于服务器端减少了代码量啊
  • 正常的生活中购物，在收银结账时，不要的商品自然要放下（删除）掉的，之后再把购物车所有商品结账。

4.2 查看订单

• 地址：　/api/v1/myorder/
• 方法： GET
• 必选参数：token
• 可选参数：status，如果有这个参数，则返回此类型所有订单的信息，如果没有这个参数，则返回所有的订单信息

• 例如：

  • 没有参数status,即/api/v1/myorder?token=adfad

    {
    "state": "OK", "orderlist":
    [
            {
            "order_id": "20150102202122001", "user_id": "test",
            "busi_id":"testbusi", "order_status": 1,
            "total":100.0, "address":"China",
            "submit_time":"20150102202122",
            "pay_time":"","send_time":""
            }
            {
            "order_id": "20150102202325003", "user_id": "test",
            "busi_id":"testbusi", "order_status": 2,
            "total":100.0, "address":"China",
            "submit_time":"20150102202325",
            "pay_time":"20150102203000","send_time":""
            }
    ]
    }   

  • 有参数/api/v1/myorder?status=1&token=adfadfa

    {
    "state": "OK", "orderlist":
    [
            {
            "order_id": "20150102202122001", "user_id": "test",
            "busi_id":"testbusi", "order_status": 1,
            "total":100.0, "address":"China",
            "submit_time":"20150102202122",
            "pay_time":"","send_time":""
            }
    ]
    }   

  state 有OK,error,not login
submit_time,send_time,pay_time格式为年年年年月月日日时时分分秒秒

  4.3 查看订单详情

• 地址: /api/v1/orderdetail/
• 方法：GET
• 必选参数: order_id, token
• 例如：　
  /api/v1/orderdetail?order_id=20150102202122001&token=adfa
  返回数据

{
    "state”: “OK”, 
    "order": {
        "order_id": "20150102202122001", "user_id": "test",
        "busi_id":"testbusi", "order_status": 1,
        "total":100.0, "address":"China",
        "submit_time":"20150102202122",
        "pay_time":"","send_time":""
    }
    "detail": 
    [
        {"order_id":"20150102202122001",               
        "qcode":"1223234","num":4,"total_price”:5.0}
        {"order_id":"20150102202122001",               
        "qcode":"122355666","num":1,"total_price”:6.0}
    ]
}

state 有OK,error,not login

4 用户退出

• 地址: /api/v1/userlogout/
• 方法：GET
• 必选参数：token
• 返回数据
• 例如：/api/v1/userlogout?token=706977286e5d86598e4a8b9406603cb8

{
    "state":”OK”
}

state有　OK, not login, error