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

Posted 亮点菌

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了微信小程序电商移动前端API文档相关的知识，希望对你有一定的参考价值。

文章目录

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

https://www.zhengzhicheng.cn
备用：
https://autumnfish.cn/wx
https://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?goods_id=129"
        ,
        
            "image_src": "https://www.zhengzhicheng.cn/pyg/banner2.png",
            "open_type": "navigate",
            "goods_id": 395,
            "navigator_url": "/pages/goods_detail/main?goods_id=395"
        ,
        
            "image_src": "https://www.zhengzhicheng.cn/pyg/banner3.png",
            "open_type": "navigate",
            "goods_id": 38,
            "navigator_url": "/pages/goods_detail/main?goods_id=38"
        
    ],
    "meta":  "msg": "获取成功", "status": 200
获取首页分类选项数据
  • 请求路径：https://请求域名/api/public/v1/home/catitems
  • 请求方法：GET
  • 请求参数
参数名参数说明备注
无
  • 响应参数
参数名参数说明备注
name名称
image_src图片路径
open_type导航链接类型
navigator_url导航链接路径
  • 响应数据

    "message": [
        
            "name": "分类",
            "image_src": "https://www.zhengzhicheng.cn/pyg/icon_index_nav_4@2x.png",
            "open_type": "switchTab",
            "navigator_url": "/pages/category/main"
        ,
        
            "name": "秒杀拍",
            "image_src": "https://www.zhengzhicheng.cn/pyg/icon_index_nav_3@2x.png"
        ,
        
            "name": "超市购",
            "image_src": "https://www.zhengzhicheng.cn/pyg/icon_index_nav_2@2x.png"
        ,
        
            "name": "母婴品",
            "image_src": "https://www.zhengzhicheng.cn/pyg/icon_index_nav_1@2x.png"
        
    ],
    "meta":  "msg": "获取成功", "status": 200
获取首页楼层数据
  • 请求路径：https://请求域名/api/public/v1/home/floordata
  • 请求方法：GET
  • 请求参数
参数名参数说明备注
无
  • 响应参数
参数名参数说明备注
floor_title楼层标题
product_list楼层内容列表
name名称
image_src图片路径
image_width商品图片宽度
open_type导航链接类型
navigator_url导航链接路径
  • 响应数据

    "message": [
        
            "floor_title": 
                "name": "时尚女装",
                "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor01_title.png"
            ,
            "product_list": [
                
                    "name": "优质服饰",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor01_1@2x.png",
                    "image_width": "232",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=服饰"
                ,
                
                    "name": "春季热门",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor01_2@2x.png",
                    "image_width": "233",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=热"
                ,
                
                    "name": "爆款清仓",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor01_3@2x.png",
                    "image_width": "233",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=爆款"
                ,
                
                    "name": "倒春寒",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor01_4@2x.png",
                    "image_width": "233",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=春季"
                ,
                
                    "name": "怦然心动",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor01_5@2x.png",
                    "image_width": "233",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=心动"
                
            ]
        ,
        
            "floor_title": 
                "name": "户外活动",
                "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor02_title.png"
            ,
            "product_list": [
                
                    "name": "勇往直前",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor02_1@2x.png",
                    "image_width": "232",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=户外"
                ,
                
                    "name": "户外登山包",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor02_2@2x.png",
                    "image_width": "273",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=登山包"
                ,
                
                    "name": "超强手套",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor02_3@2x.png",
                    "image_width": "193",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=手套"
                ,
                
                    "name": "户外运动鞋",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor02_4@2x.png",
                    "image_width": "193",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=运动鞋"
                ,
                
                    "name": "冲锋衣系列",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor02_5@2x.png",
                    "image_width": "273",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=冲锋衣"
                
            ]
        ,
        
            "floor_title": 
                "name": "箱包配饰",
                "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor03_title.png"
            ,
            "product_list": [
                
                    "name": "清新气质",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor03_1@2x.png",
                    "image_width": "232",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=饰品"
                ,
                
                    "name": "复古胸针",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor03_2@2x.png",
                    "image_width": "263",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=胸针"
                ,
                
                    "name": "韩版手链",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor03_3@2x.png",
                    "image_width": "203",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=手链"
                ,
                
                    "name": "水晶项链",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor03_4@2x.png",
                    "image_width": "193",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=水晶项链"
                ,
                
                    "name": "情侣表",
                    "image_src": "https://www.zhengzhicheng.cn/pyg/pic_floor03_5@2x.png",
                    "image_width": "273",
                    "open_type": "navigate",
                    "navigator_url": "/pages/goods_list?query=情侣表"
                
            ]
        
    ],
    "meta":  "msg": "获取成功", "status": 200

（2）商品API

商品列表搜索

  • 请求路径：https://请求域名/api/public/v1/goods/search

  • 请求方法：GET

  • 请求参数

参数名参数说明备注
query查询关键词
cid分类ID可选
pagenum页数索引可选默认第一页
pagesize每页长度可选默认20条
  • 响应参数
参数名参数说明备注
total总共记录
pagenum当前页数
goods_id商品ID
cat_id分类ID
goods_name商品名称
goods_price商品价格
goods_number商品数量
goods_weight商品重量
goods_big_logo商品大图标
goods_small_logo商品小图标
add_time商品添加时间
upd_time商品更新时间
hot_mumber热门商品数
cat_one_id所属一级分类
cat_two_id所属二级分类
cat_three_id所属三级分类
  • 响应数据

    "message": 
        "total": 2058,
        "pagenum": "1",
        "goods": [
            
                "goods_id": 57332,
                "cat_id": 998,
                "goods_name": "400毫升 海鲜食品冷藏冰包 注水冰袋医用冰袋户外冷藏保鲜熟食冷藏反复使用（10个装）",
                "goods_price": 14,
                "goods_number": 100,
                "goods_weight": 100,
                "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",
                "add_time": 1516662792,
                "upd_time": 1516662792,
                "hot_mumber": 0,
                "is_promote": false,
                "cat_one_id": 962,
                "cat_two_id": 981,
                "cat_three_id": 998
            ,
            
                "goods_id": 57194,
                "cat_id": 992,
                "goods_name": "亿力洗车工具汽车美容用品海绵刷不伤车漆擦车海棉清洁海绵",
                "goods_price": 29,
                "goods_number": 100,
                "goods_weight": 100,
                "goods_big_logo": "",
                "goods_small_logo": "",
                "add_time": 1516662312,
                "upd_time": 1516662312,
                "hot_mumber": 0,
                "is_promote": false,
                "cat_one_id": 962,
                "cat_two_id": 980,
                "cat_three_id": 992
            
        ]
    ,
    "meta": 
        "msg": "获取成功",
        "status": 200
搜索建议查询
  • 请求路径：https://请求域名/api/public/v1/goods/qsearch
  • 请求方法：GET
  • 请求参数
参数名参数说明备注
query查询内容如： goods/qsearch?query=小米
  • 响应参数
参数名参数说明备注
goods_id商品ID
goods_name商品名称
  • 响应数据

    "message": [
        
            "goods_id": 57332,
            "goods_name": "400毫升 海鲜食品冷藏冰包 注水冰袋医用冰袋户外冷藏保鲜熟食冷藏反复使用（10个装）"
        ,
        
            "goods_id": 57194,
            "goods_name": "亿力洗车工具汽车美容用品海绵刷不伤车漆擦车海棉清洁海绵"
        
    ],
    "meta": 
        "msg": "获取成功",
        "status": 200
商品详情

  • 请求路径：https://请求域名/api/public/v1/goods/detail

  • 请求方法：GET

  • 请求参数

参数名参数说明备注
goods_id商品ID必要
  • 响应参数
参数名参数说明备注
goods_id商品ID
cat_id分类ID
goods_name商品名称
goods_price商品价格
goods_number商品数量
goods_weight商品重量
goods_big_logo商品大图标
goods_small_logo商品小图标
add_time商品添加时间
upd_time商品更新时间
hot_mumber热门商品数
cat_one_id所属一级分类
cat_two_id所属二级分类
cat_three_id所属三级分类
goods_introduce商品介绍html富文本
pics商品图片列表
attrs商品属性列表
  • 响应数据

    "message": 
        "goods_id": 57332,
        "cat_id": 998,
        "goods_name": "400毫升 海鲜食品冷藏冰包 注水冰袋医用冰袋户外冷藏保鲜熟食冷藏反复使用（10个装）",
        "goods_price": 14,
        "goods_number": 100,
        "goods_weight": 100,
        "goods_introduce": "<div class=\\"lazyimg\\"><!-- Save for Web Slices (20170730关联模板.psd) -->\\n<p><img data-src=\\"//image.suning.cn/uimg/sop/commodity/167890268714163515505319_x.jpg?from=mobile&amp;format=80q.webp\\" alt=\\"\\" usemap=\\"#Map\\" border=\\"0\\" src=\\"//image.suning.cn/uimg/sop/commodity/167890268714163515505319_x.jpg?from=mobile&format=80q.webp\\" width=\\"100%\\" height=\\"auto\\"> </p>\\n<!-- End Save for Web Slices --><p></p><p><img picsize=\\"706KB\\" data-src=\\"//image.suning.cn/uimg/sop/phonecomm/157271695856956094412300_640x.jpg?from=mobile&amp;format=80q.webp\\" alt=\\"\\" src=\\"//image.suning.cn/uimg/sop/phonecomm/157271695856956094412300_640x.jpg?from=mobile&format=80q.webp\\" width=\\"100%\\" height=\\"auto\\"></p><p><img picsize=\\"610KB\\" data-src=\\"//image.suning.cn/uimg/sop/phonecomm/192892939814201549766135_640x.jpg?from=mobile&amp;format=80q.webp\\" alt=\\"\\" src=\\"//image.suning.cn/uimg/sop/phonecomm/192892939814201549766135_640x.jpg?from=mobile&format=80q.webp\\" width=\\"100%\\" height=\\"auto\\"></p></div>",
        "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":  天河微信小程序入门《四》：融会贯通，form表单提交数据库


 微信小程序资源汇总整理


 微信小程序资源汇总整理


 天河微信小程序入门《三》：打通任督二脉，前后台互通


 微信小程序一般去哪里对接一些商品接口


 计算机毕业设计ssm+vue基本微信小程序的执法助手平台