一、文檔說明
1、對接流程
對接人員需要首先根據文檔要求,開發電商平臺開放接口,并提供外部可訪問的API接口地址;然后在菠蘿派商城中申請應用,將接口地址放到菠蘿派賬號信息中。菠蘿派商城賬號的創建可參考菠蘿派商城接入指南文檔:http://polyapi.com/Help/PlatDesc/polymall
2、接口約定
請求平臺值的參數大小寫與文檔相符,平臺返回參數大小不敏感
所有接口均使用http請求來調用
數據統一使用utf-8編碼
數據傳參統一用json格式
所有接口請求地址相同,僅通過方法名稱method傳參的不同來區分不同的接口。
3、接口調用說明
公共請求參數
參數 | 類型 | 是否必填 | 最大長度 | 描述 | 示例值 |
---|---|---|---|---|---|
method | String | 必填 | 64 | 方法名稱 | Differ.JH.Logistics.PostOrder |
appkey | String | 必填 | 64 | 應用編號,點此申請 | 438b2f6ff103422a98a9349507293bb2 |
token | String | 必填 | 64 | 訪問令牌 | 9415c33b04d24c7dae320b0185f42fb0 |
bizcontent | String | 必填 | 2000 | 業務參數(json數據格式) | {"a":"a1","b":"b1"},具體請參考下面示例 |
sign | String | 必填 | 512 | 商戶請求參數的簽名串 | b43537d3768636f57d1c24f64188b22a |
參數說明:
method:不同功能的接口需要傳的method的值不同
appkey:用戶在菠蘿派平臺申請應用時可以獲得;
token:用戶店鋪訪問令牌;
bizcontent:各接口請求參數以json格式合并
sign: 商戶請求參數的簽名串 (詳情可參見菠蘿派簽名算法:http://polyapi.com/Help/PlatDesc/polysign)
公共請求實例
appkey=f2c0a820992743f8b293f4b027265df0&method=Differ.JH.Business.GetOrder&token=95a8d1a00b6dfbadc3da07805131931e&bizcontent={"OrderStatus":"JH_02","StartTime":"2016-11-21+15:01:02","EndTime":"2016-12-06+15:01:02","PlatOrderNo":"","PageIndex":1,"PageSize":30,"ShopType":"","TimeType":"JH_01"}&sign=bf51fc3e4bbc25bf0ac73a9ec60edc9f
公共響應參數
參數 | 類型 | 是否必填 | 平臺 | 最大長度 | 描述 | 示例值 |
---|---|---|---|---|---|---|
code | String | 必填 | 通用 | 64 | 返回碼 | 10000 |
message | String | 必填 | 通用 | 64 | 返回消息 | Success |
subcode | String | 必填 | 通用 | 200 | 子集編碼 | LXO.JD.REQUEST_FAIL |
submessage | String | 必填 | 通用 | 200 | 子級消息 | 訂單已出庫 |
公共返參實例
{
"code": "40000",
"message": "System Error",
"subcode": "GSE.SYSTEM_ERROR",
"submessage": "[20887]服務異常請稍后再試"
}