一、文档说明
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]服务异常请稍后再试"
}