【微信小程序】电商移动前端API文档

文章目录

- 一、文档更新说明
- - 1、返回值调整
  - 2、分类页图片
  - 3、订单支付接口
- 二、路径说明
- 三、电商登录实现方式
- 四、API详情
- - 1、全局权限访问
  - - （1）主页API
    - - 获取首页轮播图数据
      - 获取首页分类选项数据
      - 获取首页楼层数据
    - （2）商品API
    - - 商品列表搜索
      - 搜索建议查询
      - 商品详情
    - （3）分类API
    - - 获取分类数据
    - （4）微信用户登录 API
    - - 微信登录换取 Token
  - 2、登录后访问
  - - （1）订单API
    - - 创建订单
      - 订单预支付
      - 订单支付状态查询
      - 订单查询

request域名：小程序只支持 https 协议，并且要求是已备案的域名。

https://www.zhengzhicheng.cn备用：https://autumnfish.cn/wxhttps://www.uinav.com

一、文档更新说明

更新日期 2019-04-01

1、返回值调整

新版接口调整：  res.data.message旧版接口废弃：  res.data.data

2、分类页图片

新版接口调整：  cat_icon 属性直接返回完整图片 url 地址旧版接口废弃：  cat_icon 返回相对路径，需要手动拼接路径

3、订单支付接口

新版接口调整：  支付对象数据为 res.data.message.pay旧版接口废弃：  支付对象数据为 res.data.data.wxorder

二、路径说明

根路径说明

https://请求域名/api/public/v1

路径权限说明
- 路径所有权限都可以访问
```
https://请求域名/api/public/v1
```
- 只有登录用户才可以访问路径
```
https://请求域名/api/public/v1/my
```

三、电商登录实现方式

采用 jwt 方式进行
实现流程
1. 请求登录
2. 获取token
3. 访问有权限的路径必须把 token 放置到 http 头中
```
"Authorization" : token
```
1. token 不过期，长期有效。

四、API详情

1、全局权限访问

访问根路径

https://请求域名/api/public/v1

（1）主页API

获取首页轮播图数据

请求路径：https://请求域名/api/public/v1/home/swiperdata
请求方法：GET
请求参数

参数名	参数说明	备注
无

响应参数

参数名	参数说明	备注
image_src	图片路径
open_type	导航链接类型
navigator_url	导航链接路径

响应数据参考

{    "message": [        {            "image_src": "https://www.zhengzhicheng.cn/pyg/banner1.png",            "open_type": "navigate",            "goods_id": 129,            "navigator_url": "/pages/goods_detail/main" /> 
\n
",        "goods_big_logo": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_800x800.jpg",        "goods_small_logo": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_400x400.jpg",        "goods_state": 2,        "is_del": "0",        "add_time": 1516662792,        "upd_time": 1516662792,        "delete_time": null,        "hot_mumber": 0,        "is_promote": false,        "cat_one_id": 962,        "cat_two_id": 981,        "cat_three_id": 998,        "goods_cat": "962,981,998",        "pics": [            {                "pics_id": 234751,                "goods_id": 57332,                "pics_big": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_800x800.jpg",                "pics_mid": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_400x400.jpg",                "pics_sma": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_200x200.jpg",                "pics_big_url": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_800x800.jpg",                "pics_mid_url": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_400x400.jpg",                "pics_sma_url": "http://image4.suning.cn/uimg/b2c/newcatentries/0070083251-000000000168369396_1_200x200.jpg"            }        ],        "attrs": [            {                "goods_id": 57332,                "attr_id": 8519,                "attr_value": "400",                "add_price": 0,                "attr_name": "主体-型号",                "attr_sel": "only",                "attr_write": "manual",                "attr_vals": "Q6"            }        ]    },    "meta": {        "msg": "获取成功",        "status": 200    }}

（3）分类API

获取分类数据

请求路径：https://请求域名/api/public/v1/categories
请求方法：GET
请求参数

参数名	参数说明	备注
无

响应参数

参数名	参数说明	备注
cat_id	分类ID
cat_name	分类名称
cat_level	分类级别
cat_icon	分类图标	只有3级别分类采用图标
children	子分类列表	对象数组

响应数据

{    "message": [        {            "cat_id": 1,            "cat_name": "大家电",            "cat_pid": 0,            "cat_level": 0,            "cat_deleted": false,            "cat_icon": "",            "children": [                {                    "cat_id": 3,                    "cat_name": "电视",                    "cat_pid": 1,                    "cat_level": 1,                    "cat_deleted": false,                    "cat_icon": "",                    "children": [                    {                        "cat_id": 5,                        "cat_name": "曲面电视",                        "cat_pid": 3,                        "cat_level": 2,                        "cat_deleted": false,                        "cat_icon": "full/2fb113b32f7a2b161f5ee4096c319afedc3fd5a1.jpg"                    }]                }            ]        }    ],    "meta": {        "msg": "获取成功",        "status": 200    }}

（4）微信用户登录 API

微信登录换取 Token

请求路径：https://请求域名/api/public/v1/users/wxlogin
请求方法：POST
请求参数

参数名	参数说明	备注
code	用户登录凭证	必要，可通过 wx.login() 获取
encryptedData	完整用户信息密文	必要，可通过 getUserInfo 获取
iv	加密算法的初始向量	必要，可通过 getUserInfo 获取
rawData	用户信息原始数据字符串	必要，可通过 getUserInfo 获取，JSON.stringify() 转字符串
signature	使用 sha1得到字符串	必要，可通过 getUserInfo 获取

请求数据参考

{  "code": "013pZWCt0GniKb1ftkBt0AxfDt0pZWCf",  "encryptedData": "FGMaNbO4ytTFTUzK3wmtfHWoFeQJYkyMajQ5tVbQglwmnJ46SMi43Thq0OZjSSa5Msmnpdfx7yigYkdvUbsiQFyF9xMGEQLpUFcpNjnYoCQOl2Ka5zEeqpMY91ywYAsPISeu1rwvFCU2Ucenxf7gdcDPQ/jNJdORGb86DR+2gVJeg8TZiXWJ66enpynj35DiaE1jNWUSzpgbOvO40dZrWnHVwDEJN+upeSHRR/IW7t3cgtV63/GeZzNhFbUYqNHO6M1KHetwY1u8mFXuZoXwVV7DrEwEzY1btqcfW93q4ekn2uwAUeJM4U+3roBsIT5ZpEM8YtQZVsAwjaWHBe8id1H4lurEFC5/GwLnRONrIiR7KDF7MPxnMO9flWFQEfay5dt9rBELzk1Efjf2H6UnzYfh+o4MbPxtc0cUiHEnNCVcXjDtulXSRUy7RZQPmjF/tYBHHrXEFubxnK4oRBZz/A==",  "iv": "y/ESFBaesbEzIbB1th5Knw==",  "rawData":    "{\"nickName\":\"优购\",\"gender\":0,\"language\":\"zh_CN\",\"city\":\"\",\"province\":\"\",\"country\":\"\",\"avatarUrl\":\"https://wx.qlogo.cn/mmopen/vi_32/icWlxE4rARHaIlib1PRmBtRa2tQicUSEHYu8UIGZ0LLic9C0PticibED6brRFCuQYeLGtwTcBYFgMtcF11N31pVhMF8g/132\"}",  "signature": "d06cd3a54e89e6014e43694844706eaccad109bb"}

响应参数参考

参数名	参数说明	备注
token	身份验证标志
user_id	用户ID

响应数据

{  "message": {    "user_id": 12,    "user_email_code": null,    "is_active": null,    "user_sex": "男",    "user_qq": "",    "user_tel": "",    "user_xueli": "本科",    "user_hobby": "",    "user_introduce": null,    "create_time": 1525402223,    "update_time": 1525402223,    "token":      "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjEyLCJpYXQiOjE1MjU0MDIyMjMsImV4cCI6MTUyNTQ4ODYyM30.g-4GtEQNPwT_Xs0Pq7Lrco_9DfHQQsBiOKZerkO-O-o"  },  "meta": { "msg": "登录成功", "status": 200 }}

2、登录后访问

访问根路径

https://请求域名/api/public/v1/my

访问此系列请求必须在头信息中添加token

"Authorization" : token

（1）订单API

创建订单

请求路径：https://请求域名/api/public/v1/my/orders/create
请求方法：POST
请求参数

参数名	参数说明	备注
order_price	订单价格	必要
consignee_addr	订单地址	必要
order_detail	订单详情	可选，字符串格式
goods	商品列表内部存放商品（goods_id，goods_number和goods_price）列表	必要

请求数据参考

{  "order_price": 0.1,  "consignee_addr": "广州市天河区",  "order_detail":    "[{\"goods_id\":55578,\"goods_name\":\"初语2017秋装新款潮牌女装加绒宽松BF风慵懒卫衣女套头连帽上衣\",\"goods_price\":279,\"goods_small_logo\":\"http://image2.suning.cn/uimg/b2c/newcatentries/0070067836-000000000690453616_2_400x400.jpg\",\"counts\":1,\"selectStatus\":true}]",  "goods": [      {           "goods_id": 5,           "goods_number": 11,           "goods_price": 15       },      {           "goods_id": 555,           "goods_number": 1,           "goods_price": 15       }  ]}

响应参数

参数名	参数说明	备注
order_id	订单唯一ID
user_id	用户ID
order_number	订单编号
order_price	订单总金额
order_pay	订单支付方式	支付方式 0未支付 1支付宝 2微信 3银行卡
consignee_addr	订单地址
pay_status	订单支付状态	订单状态： 0未付款、1已付款

响应数据参考

{  "message": {    "order_id": 45,    "user_id": 12,    "order_number": "GD20180504000000000045",    "order_price": 0.1,    "order_pay": "0",    "is_send": "否",    "trade_no": "",    "order_fapiao_title": "个人",    "order_fapiao_company": "",    "order_fapiao_content": "",    "consignee_addr": "广州市天河区",    "pay_status": "0",    "create_time": 1525408071,    "update_time": 1525408071,    "order_detail":      "[{\"goods_id\":55578,\"goods_name\":\"初语2017秋装新款潮牌女装加绒宽松BF风慵懒卫衣女套头连帽上衣\",\"goods_price\":279,\"goods_small_logo\":\"http://image2.suning.cn/uimg/b2c/newcatentries/0070067836-000000000690453616_2_400x400.jpg\",\"counts\":1,\"selectStatus\":true}]",    "goods": [      {        "id": 64,        "order_id": 45,        "goods_id": 5,        "goods_price": 15,        "goods_number": 11,        "goods_total_price": 15      }    ]  },  "meta": { "msg": "创建订单成功", "status": 200 }}

订单预支付

请求路径：https://请求域名/api/public/v1/my/orders/req_unifiedorder
请求方法：POST
请求参数

参数名	参数说明	备注
order_number	订单编号	必要

请求数据

{ "order_number": "GD20180507000000000110" }

响应参数

参数名	参数说明	备注
pay	订单对象	可通过 wx.requestPayment(OBJECT)，发起微信支付
timeStamp	时间戳
nonceStr	随机字符串
package	下单接口返回参数
signType	签名算法
paySign	签名
order_number	订单编号

响应数据

{  "message": {    "pay": {      "timeStamp": "1525681145",      "nonceStr": "BkPggorBXZwPGXe3",      "package": "prepay_id=wx071619042918087bb4c1d3d72999385683",      "signType": "MD5",      "paySign": "D1642DEEF1663C8012EDEB9297E1D516"    },    "order_number": "GD20180507000000000110"  },  "meta": { "msg": "预付订单生成成功", "status": 200 }}

订单支付状态查询

请求路径：https://请求域名/api/public/v1/my/orders/chkOrder
请求方法：POST
请求参数

参数名	参数说明	备注
order_number	订单编号	必要

请求数据

{ "order_number": "GD20180507000000000050" }

响应参数

参数名	参数说明	备注
data	支付状态
meta	订单状态

响应数据

// 支付成功{    "message":"支付成功",    "meta":{"msg":"验证成功","status":200}}// 支付失败{     "message": null,    "meta": { "msg": "订单未支付", "status": 400 } }

订单查询

请求路径：https://请求域名/api/public/v1/my/orders/all
请求方法：GET
请求参数

参数名	参数说明	备注
type	1	1 全部订单 2 代付款订单 3 已付款订单

2响应参数

参数名	参数说明	备注
order_id	订单唯一ID
user_id	用户ID
order_number	订单编号
order_price	订单价格
order_pay	订单支付方式
consignee_addr	订单地址
pay_status	订单支付状态

响应数据

{  "message": [    {      "order_id": 44,      "user_id": 12,      "order_number": "GD20180507000000000050",      "order_price": 0.1,      "order_pay": "0",      "is_send": "否",      "trade_no": "",      "order_fapiao_title": "个人",      "order_fapiao_company": "",      "order_fapiao_content": "",      "consignee_addr": "广州市天河区",      "pay_status": "0",      "create_time": 1525407814,      "update_time": 1525407814,      "order_detail":        "[{\"goods_id\":55578,\"goods_name\":\"初语2017秋装新款潮牌女装加绒宽松BF风慵懒卫衣女套头连帽上衣\",\"goods_price\":279,\"goods_small_logo\":\"http://image2.suning.cn/uimg/b2c/newcatentries/0070067836-000000000690453616_2_400x400.jpg\",\"counts\":1,\"selectStatus\":true}]"    }  ],  "meta": { "msg": "获取订单列表成功", "status": 200 }}

【微信小程序】电商移动前端API文档

文章目录

一、文档更新说明

1、返回值调整

2、分类页图片

3、订单支付接口

二、路径说明

三、电商登录实现方式

四、API详情

1、全局权限访问

（1）主页API

获取首页轮播图数据

（3）分类API

获取分类数据

（4）微信用户登录 API

微信登录换取 Token

2、登录后访问

（1）订单API

创建订单

订单预支付

订单支付状态查询

订单查询

最新关注

热文推荐

【Node.js实战】一文带你开发博客项目（MySQL基础）

【MySQL 第十二天事务的介绍|InnoDB使用事务】

库存预占架构升级方案设计-交易库存中心

谈安全测试的重要性

react-router-dom V6 中文文档教程总结

Python 中的单下划线和双下划线

【微信小程序】电商移动前端API文档

文章目录

一、文档更新说明

1、返回值调整

2、分类页图片

3、订单支付接口

二、路径说明

三、电商登录实现方式

四、API详情

1、全局权限访问

（1）主页API

获取首页轮播图数据

（3）分类API

获取分类数据

（4）微信用户登录 API

微信登录换取 Token

2、登录后访问

（1）订单API

创建订单

订单预支付

订单支付状态查询

订单查询

相关文章

最新关注

热文推荐