微信小程序拼團後端接口設計規範

時間  2019-11-08
標籤 微信 程序 後端 接口 設計規範 欄目 設計模式 简体版
原文   原文鏈接

來源：https://share.notestore.cn/ac...html

公告列表

接口地址：算法

g=Api&m=Banner&a=lists

返回說明

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

商品列表

接口地址：express

g=Api&m=Goods&a=lists&offset=OFFSET&size=SIZE

請求參數

參數 必填 說明
offset 是 偏移量
size 是 條數

返回說明

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

//數據爲空返回，返回的JSON數據包
{
    "goods": [],
    "result": "ok"
}

商品詳情

接口地址：小程序

g=Api&m=Goods&a=detail&goods_id=GOODS_ID

請求參數

參數 必填 說明
goods_id 是 商品ID

返回說明

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

//錯誤時返回JSON數據包(示例爲Goods_ID無效)
{
    "result": "fail",
    "error_code": 41002,
    "error_info": "商品已下架或不存在"
}

訂單列表

接口地址：api

g=Api&m=Weuser&a=order&offset=OFFSET&size=SIZE&token=TOKEN

請求參數

參數 必填 說明
offset 是 偏移量
size 是 條數
token 是 登錄令牌

返回說明

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

//數據爲空返回，返回的JSON數據包
{
    "order_list": [],
    "result": "ok"
}

訂單詳情

接口地址：微信

g=Api&m=Weuser&a=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": "訂單不存在"
}

生成訂單

接口地址：app

http請求方式: POST
g=Api&m=Weuser&a=orders&token=TOKEN

各訂單類型所需的JSON數據包以下：微信支付

生成單購訂單加密

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

生成團購訂單code

{
    "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 建立訂單失敗

取消訂單

接口地址：

g=Api&m=Weuser&a=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: "已發貨退款成功"
},

地址列表

接口地址：

g=Api&m=Weuser&a=addresses&token=TOKEN

請求參數

參數 必填 說明
token 是 登錄令牌

返回說明

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

添加地址

接口地址：(TOKEN 需換成登錄令牌)

g=Api&m=Weuser&a=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) 

g=Api&m=Weuser&a=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) 

g=Api&m=Weuser&a=addresses&token=TOKEN&address_id=ADDRESS_ID

HTTP請求方式：

PUT

PUT參數說明：

參數 必填 說明
status 是 DEFAULT

示例：

{
    "status": "DEFAULT"
}

返回說明

//正常返回的JSON數據包
{
    "result": "ok"
}

刪除地址

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

g=Api&m=Weuser&a=address&address_id=ADDRESS_ID&token=TOKEN

HTTP請求方式：

DELETE

返回說明

//正常返回的JSON數據包
{
    "result": "ok"
}

拼團列表

接口地址：

g=Api&m=Weuser&a=groups&offset=OFFSET&size=SIZE&token=TOKEN

請求參數

參數 必填 說明
offset 是 偏移量
size 是 條數

返回說明

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

//數據爲空返回，返回的JSON數據包
{
    "group_orders": [],
    "result": "ok"
}

拼團詳情

接口地址：

g=Api&m=Weuser&a=group_orders&token=TOKEN&id=ID

請求參數

參數 必填 說明
id 是 拼團ID

返回說明

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

//錯誤時返回JSON數據包(示例爲團ID無效)
{
    "result": "fail",
    "error_code": 41001,
    "error_info": "該團不存在"
}

拼團狀態

"group_status": {
    }

微信支付

接口地址：

g=Api&m=Weuser&a=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 已加入過此團

用戶信息

接口地址：

g=Api&m=Weuser&a=me&token=TOKEN

請求參數

參數 必填 說明
token 是 登錄令牌

返回說明

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

//錯誤時返回JSON數據包(示例爲Token無效)
{
    "result": "fail",
    "error_code": 40001,
    "error_info": "用戶校驗失敗"
}

微信類

小程序登錄

接口地址：

g=api&m=WeApp&a=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 需換成登錄令牌) 

g=api&m=WeApp&a=login&token=TOKEN

HTTP請求方式：

PUT

PUT參數說明：

參數 必填 說明
encryptedData 是 包括敏感數據在內的完整用戶信息的加密數據
iv 是 加密算法的初始向量

注意：請求參數 來源於 wx.getUserInfo

示例：

{
    "iv": "IV",
    "encryptedData": ENCRYPTEDDATA"
}
返回說明
//正常返回的JSON數據包
{
    "result": "ok"
}

通用類

地區列表

接口地址：

g=api&m=project&a=regions

返回說明

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

地區數據版本

接口地址：

g=api&m=project&a=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": "非法參數"
}

查看物流

接口地址：

g=api&m=Project&a=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教程