微信小程序拼团后端接口设计规范.V2

时间  2019-11-08
标签 微信 程序 后端 接口 设计规范 v2 栏目 设计模式 繁體版
原文   原文链接

概要

来源：https://pinapp.github.io/w5/apihtml

基于拼团后端接口简约的特色，咱们拟定了后端小程序拼团接口设计指南和建议。
适合 0 - 1 构建拼团商城不错参考。

公告列表

接口地址：git

Api/Banner/lists

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "banners": [
        {
        }
    ]
}

商品列表

接口地址：github

Api/Goods/lists?offset=OFFSET&size=SIZE

请求参数

参数 必填 说明
offset 是 偏移量
size 是 条数

返回说明

//正常返回的JSON数据包
{
    "goods": [
        {
           
        }
    ],
    "result": "ok"
}

//数据为空返回，返回的JSON数据包
{
    "goods": [],
    "result": "ok"
}

商品详情

接口地址：算法

Api/Goods/detail?goods_id=GOODS_ID

请求参数

参数 必填 说明
goods_id 是 商品ID

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "goods": {
        
    },
    "gallery": [
        {
           
        }
    ]
}

//错误时返回JSON数据包(示例为Goods_ID无效)
{
    "result": "fail",
    "error_code": 41002,
    "error_info": "商品已下架或不存在"
}

订单列表

接口地址：express

Api/Weuser/order?offset=OFFSET&size=SIZE&token=TOKEN

请求参数

参数 必填 说明
offset 是 偏移量
size 是 条数
token 是 登录令牌

返回说明

//正常返回的JSON数据包
{
    "order_list": [
        {
        }
    ],
    "result": "ok"
}

//数据为空返回，返回的JSON数据包
{
    "order_list": [],
    "result": "ok"
}

订单详情

接口地址：小程序

Api/Weuser/getorder?token=TOKEN&order_id=ORDER_ID

请求参数

参数 必填 说明
order_id 是 订单ID
token 是 登录令牌
返回说明
//正常返回的JSON数据包
{
    "order": {
    },
    "result": "ok"
}

//错误时返回JSON数据包(示例为Order_ID无效)
{
    "result": "fail",
    "error_code": 41001,
    "error_info": "订单不存在"
}

生成订单

接口地址：后端

http请求方式: POST
Api/Weuser/orders?token=TOKEN

各订单类型所需的JSON数据包以下：api

生成单购订单微信

{
    "goods_id": "GOODS_ID",
    "address_id": "ADDRESS_ID",
    "groupbuy": 0,
    "group_order_id": 0
}

生成团购订单app

{
    "goods_id": "GOODS_ID",
    "address_id": "ADDRESS_ID",
    "groupbuy": 1,
    "group_order_id": 0
}

生成参团订单

{
    "goods_id": "GOODS_ID",
    "address_id": "ADDRESS_ID",
    "groupbuy": 1,
    "group_order_id": GROUP_ORDER_ID
}

请求参数

参数 必填 说明
token 是 登录令牌
goods_id 是 商品ID
address_id 是 用户地址ID
groupbuy 是 是否团购订单
group_order_id 是 参团ID

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "order_id": 16
}

//错误时返回JSON数据包(示例为Goods_ID无效)
{
  "result" : "fail",
  "error_code" : 41002,
  "error_info" : "该商品不存在"
}

返回码说明

参数 说明
41002 商品不存在
42042 商品已售罄
42042 地址不存在
41002 商品一人限购
41003 团不存在
41003 团已满员
41003 团已关闭
41003 已加入过此团
41002 建立订单失败

取消订单

接口地址：

Api/Weuser/cancelOrder?token=TOKEN&order_id=ORDER_ID

请求参数

参数 必填 说明
order_id 是 订单ID
token 是 登录令牌

返回说明

//正常返回的JSON数据包
{
    "result": "ok"
}

订单状态 

//订单状态
"order_status": {
    0: "待支付",
    1: "已支付，未确认",
    2: "已确认，待发货",
    3: "配送中",
    4: "已签收",
    5: "交易已取消",
    6: "未发货退款处理中",
    7: "未发货退款成功",
    8: "已发货退款处理中",
    9: "已发货退款成功"
},

地址列表

接口地址：

Api/Weuser/addresses?token=TOKEN

请求参数

参数 必填 说明
token 是 登录令牌

返回说明

//正常返回的JSON数据包
{
  "address_list" : [
    {
    }
  ],
  "result" : "ok"
}

添加地址

接口地址：(TOKEN 需换成登录令牌)

api/Weuser/address?token=TOKEN

HTTP请求方式：

POST

POST参数说明：

参数 必填 说明
receive_name 是 收货人名字
mobile 是 手机号
province 是 省份ID
city 是 城市ID
district 是 地区ID
address_name 是 地址类别 “HOME” "WORK"
address 是 详细地址

示例：

{
    "receive_name": "RECEIVE_NAME",
    "mobile": "MOBILE",
    "province": "PROVINCE",
    "city": "CITY",
    "district": "DISTRICT",
    "address_name": "HOME",
    "address": "ADDRESS"
}

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "address_id": 15
}

修改地址

接口地址：(TOKEN 需换成登录令牌 / ADDRESS_ID 需换成地址ID) 

api/Weuser/address?address_id=ADDRESS_ID&token=TOKEN

HTTP请求方式：

PUT

PUT参数说明：

参数 必填 说明
receive_name 是 收货人名字
mobile 是 手机号
province 是 省份ID
city 是 城市ID
district 是 地区ID
address_name 是 地址类别 “HOME” "WORK"
address 是 详细地址

示例：

{
    "receive_name": "RECEIVE_NAME",
    "mobile": "MOBILE",
    "province": "PROVINCE",
    "city": "CITY",
    "district": "DISTRICT",
    "address_name": "HOME",
    "address": "ADDRESS"
}

返回说明

//正常返回的JSON数据包
{
    "result": "ok"
}

设置默认地址

接口地址：(TOKEN 需换成登录令牌 / ADDRESS_ID 需换成地址ID) 

Api/Weuser/addresses?token=TOKEN&address_id=ADDRESS_ID

HTTP请求方式：

PUT

PUT参数说明：

参数 必填 说明
status 是 DEFAULT

示例：

{
    "status": "DEFAULT"
}

返回说明

//正常返回的JSON数据包
{
    "result": "ok"
}

删除地址

接口地址：(TOKEN 需换成登录令牌 / ADDRESS_ID 需换成地址ID) 

Api/Weuser/address?address_id=ADDRESS_ID&token=TOKEN

HTTP请求方式：

DELETE

返回说明

//正常返回的JSON数据包
{
    "result": "ok"
}

拼团列表

接口地址：

Api/Weuser/groups?offset=OFFSET&size=SIZE&token=TOKEN

请求参数

参数 必填 说明
offset 是 偏移量
size 是 条数

返回说明

//正常返回的JSON数据包
{
    "group_orders": [
        {
        }
    ],
    "result": "ok"
}

//数据为空返回，返回的JSON数据包
{
    "group_orders": [],
    "result": "ok"
}

拼团详情

接口地址：

Api/Weuser/group_orders?token=TOKEN&id=ID

请求参数

参数 必填 说明
id 是 拼团ID

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "group_order": {
    }
}

//错误时返回JSON数据包(示例为团ID无效)
{
    "result": "fail",
    "error_code": 41001,
    "error_info": "该团不存在"
}

拼团状态

"group_status": {
    }

微信支付

接口地址：

Api/Weuser/wxpay?token=TOKEN&order_id=ORDER_ID

请求参数

参数 必填 说明
token 是 登录令牌
order_id 是 订单ID

返回说明

//正常返回的JSON数据包
{
    "param": {
        "appId": "APPID",
        "nonceStr": "NONCESTR",
        "package": "prepay_id=PREPAY_ID",
        "signType": "MD5",
        "timeStamp": "1528247090",
        "paySign": "PAYSIGN"
    },
    "result": "ok"
}

//错误时返回JSON数据包(示例为Order_ID无效)
{
    "result": "fail",
    "error_code": 41001,
    "error_info": "订单不存在"
}

返回码说明

参数 说明
41001 订单不存在
41002 商品不存在
42042 商品已售罄
42042 地址不存在
41002 商品一人限购
41003 团不存在
41003 团已满员
41003 团已关闭
41003 已加入过此团

用户信息

接口地址：

Api/Weuser/me?token=TOKEN

请求参数

参数 必填 说明
token 是 登录令牌

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "user_info": {
    }
}

//错误时返回JSON数据包(示例为Token无效)
{
    "result": "fail",
    "error_code": 40001,
    "error_info": "用户校验失败"
}

微信类

小程序登录

接口地址：

Api/WeApp/login?code=CODE
请求参数
参数 必填 说明
code 是 wx.login(OBJECT) success 返回 参数 code
返回说明
//正常返回的JSON数据包
{
    "access_token": "ACCESS_TOKEN",
    "expires": "15282507217200",
    "refresh_token": "REFRESH_TOKEN",
    "result": "ok",
    "user_sn": "4998",
    "token": "TOKEN"
}

//错误时返回JSON数据包(示例为Code无效)
{
    "result": "fail",
    "error_code": 42032,
    "error_info": "获取用户信息失败"
}

同步用户信息

接口地址：(TOKEN 需换成登录令牌) 

Api/WeApp/login?token=TOKEN

HTTP请求方式：

PUT

PUT参数说明：

参数 必填 说明
encryptedData 是 包括敏感数据在内的完整用户信息的加密数据
iv 是 加密算法的初始向量

注意：请求参数 来源于 wx.getUserInfo

示例：

{
    "iv": "IV",
    "encryptedData": ENCRYPTEDDATA"
}
返回说明
//正常返回的JSON数据包
{
    "result": "ok"
}

通用类

地区列表

接口地址：

Api/project/regions

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "regions": {
    }
}

地区数据版本

接口地址：

Api/Project/data_version?type=region_list

请求参数

参数 必填 说明
type 是 region_list

返回说明

//正常返回的JSON数据包
{
    "result": "ok",
    "data_version": {
        "data_key": "region_list",
        "version": "234"
    }
}

//错误时返回JSON数据包(示例为Type无效)
{
    "result": "fail",
    "error_code": 42000,
    "error_info": "非法参数"
}

查看物流

接口地址：

Api/Project/express?order_id=ORDER_ID

请求参数

参数 必填 说明
order_id 是 订单ID

返回说明

//正常返回的JSON数据包
{
    "shipping": {
        "traces": [
        ],
        "shipper": "物流单号",
        "tracking_number": "物流公司"
    },
    "result": "ok"
}

//错误时返回JSON数据包(示例为Order_id无效)
{
    "result": "fail",
    "error_code": 41001,
    "error_info": "该订单不存在"
}

图片描述

扫码入群

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程