2、API 接口参数规范
接口参数规范
字段名称 | 字段说明 | 字段类型 | 是否必传参数 |
---|---|---|---|
licenseId | 商家授权码 商家授权码可联系万师傅对接负责人进行获取 参考: 1、申请授权秘钥 | String | 是 |
timestamp | 时间戳(单位: 毫秒) | Long | 是 |
busData | 业务参数. 根据每个接口具体的业务参数,转换为json 字符串,并进行base64加密得到该参数 | String | 是 |
checkData | 签名. 签名规则详细参考 API 签名校验 | String | 是 |
childAccount | 子账号 用户名 | String | 否 |
不同的接口会有不通的业务参数. 具体业务参数字段可参照对应接口文档.
busData 字段的值是接口业务参数转换为 json 对象,并进行 base64 加密后得到的值.
下单接口示例:
[
{
"address": "详细测试地址",
"appointMethod": "open",
"buyerName": "张三0",
"buyerNote": "客户备注0",
"buyerPhone": "13333333333",
"checkRepeatOrder": 0,
"city": "深圳市",
"contactName": "王a",
"contactPhone": "17777777777",
"convertSuccess": false,
"county": "宝安区",
"customArriveStatus": 1,
"deliveryMode": 2,
"direct": false,
"expectCompleteTime": "2022-05-28",
"expectDoorOnTimeAwardFee": 10,
"expectDoorOnTimeInterval": "08-10",
"fourthDivisionId": 0,
"goodsList": [
{
"dropDown": 0,
"goodsId": "8891790",
"goodsImgUrl": "https://qncdn.wanshifu.com/c186e2c2fff3090c3bcb64b885e90d98,https://qncdn.wanshifu.com/6629571f63d4d38e1e94046231e2d0ab",
"goodsName": "型号hyy01",
"goodsNote": "安装备注hyy",
"goodsNumber": 5
}
],
"logisticsCompany": "顺丰",
"needMasterpack": 0,
"needPack": 0,
"needWoodpack": 0,
"orderId": "zqeryest11111",
"outer": false,
"overrideDefault": false,
"payMethod": 1,
"province": "广东省",
"rateReward": false,
"receiverAddress": "返货地址0",
"receiverName": "李四",
"receiverPhone": "18888888888",
"serveCategory": 1,
"serveType": 4,
"spType": "master",
"subscribeLogistic": 0,
"thirdDivisionId": 0,
"version": "v2"
}
]
{
// 授权码id
"licenseId": "xxxxxx",
// 时间戳,毫秒值
"timestamp": 1596528231211,
// 订单业务参数 BASE64 加密后
"busData": "W3siYWRkcmVzcyI6Iuivpue7hua1i+ivleWcsOWdgCIsImFwcG9pbnRNZXRob2QiOiJvcGVuIiwiYnV5ZXJOYW1lIjoi5byg5LiJMCIsImJ1eWVyTm90ZSI6IuWuouaIt+Wkh+azqDAiLCJidXllclBob25lIjoiMTMzMzMzMzMzMzMiLCJjaGVja1JlcGVhdE9yZGVyIjowLCJjaXR5Ijoi5rex5Zyz5biCIiwiY29udGFjdE5hbWUiOiLnjothIiwiY29udGFjdFBob25lIjoiMTc3Nzc3Nzc3NzciLCJjb252ZXJ0U3VjY2VzcyI6ZmFsc2UsImNvdW50eSI6IuWuneWuieWMuiIsImN1c3RvbUFycml2ZVN0YXR1cyI6MSwiZGVsaXZlcnlNb2RlIjoyLCJkaXJlY3QiOmZhbHNlLCJleHBlY3RDb21wbGV0ZVRpbWUiOiIyMDIyLTA1LTI4IiwiZXhwZWN0RG9vck9uVGltZUF3YXJkRmVlIjoxMCwiZXhwZWN0RG9vck9uVGltZUludGVydmFsIjoiMDgtMTAiLCJmb3VydGhEaXZpc2lvbklkIjowLCJnb29kc0xpc3QiOlt7ImRyb3BEb3duIjowLCJnb29kc0lkIjoiODg5MTc5MCIsImdvb2RzSW1nVXJsIjoiaHR0cHM6Ly9xbmNkbi53YW5zaGlmdS5jb20vYzE4NmUyYzJmZmYzMDkwYzNiY2I2NGI4ODVlOTBkOTgsaHR0cHM6Ly9xbmNkbi53YW5zaGlmdS5jb20vNjYyOTU3MWY2M2Q0ZDM4ZTFlOTQwNDYyMzFlMmQwYWIiLCJnb29kc05hbWUiOiLlnovlj7doeXkwMSIsImdvb2RzTm90ZSI6IuWuieijheWkh+azqGh5eSIsImdvb2RzTnVtYmVyIjo1LCJoaWdoZXJUaGFuVGhyZWUiOjIsIm5lZWRTa3UiOmZhbHNlLCJ1c2VDdXN0b21JbWFnZSI6ZmFsc2UsInZhbGlkYXRvckdvb2RzTWFwcGluZyI6dHJ1ZX1dLCJpbnN1cmVkQW1vdW50IjowLCJpc0F1dG9BcHBvaW50IjowLCJsb2dpc3RpY3NDb21wYW55Ijoi6aG65LiwIiwibmVlZE1hc3RlcnBhY2siOjAsIm5lZWRQYWNrIjowLCJuZWVkV29vZHBhY2siOjAsIm9yZGVySWQiOiJ6cWVyeWVzdDExMTExIiwib3V0ZXIiOmZhbHNlLCJvdmVycmlkZURlZmF1bHQiOmZhbHNlLCJwYXlNZXRob2QiOjEsInByb3ZpbmNlIjoi5bm/5Lic55yBIiwicmF0ZVJld2FyZCI6ZmFsc2UsInJlY2VpdmVyQWRkcmVzcyI6Iui/lOi0p+WcsOWdgDAiLCJyZWNlaXZlck5hbWUiOiLmnY7lm5siLCJyZWNlaXZlclBob25lIjoiMTg4ODg4ODg4ODgiLCJzZXJ2ZUNhdGVnb3J5IjoxLCJzZXJ2ZVR5cGUiOjQsInNwVHlwZSI6Im1hc3RlciIsInN1YnNjcmliZUxvZ2lzdGljIjowLCJ0aGlyZERpdmlzaW9uSWQiOjAsInZlcnNpb24iOiJ2MiJ9XQ==",
// 签名
"checkData": "xxxxx"
}
修改于 2022-12-19 02:21:03