一、地图轨迹订阅接口
1.1 接口格式
1.使用http协议表单提交的方式进行信息交互,字符编码默认统一采用UTF-8,数据格式:application/x-www-form-urlencoded;
2.字段类型约定:需要严格依据字段表格中给出的参数格式和大小进行开发。
3.字段解析约定:参数字段中的必选字段是每次调用接口时都要求必须传入的;
1.2 请求地址
http://poll.kuaidi100.com/pollmap
请求报文:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
schema | 否 | string | 默认是json |
param | 是 | Object | 主体参数对象 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
key | 是 | string | 授权码,请申请企业版获取 |
company | 是 | string | 订阅的快递公司的编码,一律用小写字母 |
number | 是 | string | 订阅的快递单号,单号的最大长度是40个字符 |
from | 是 | string | 快递寄件地址 |
to | 是 | string | 快递收件地址 |
parameters | 是 | Object | 辅助参数 |
parameters数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
callbackurl | 是 | string | 回调接口的地址 |
salt | 否 | string | 签名用随机字符串 |
phone | 否 | string | 收寄件人的移动电话号码(只能填写一个,顺丰单号必填,其他快递公司选填) |
ordertime | 否 | string | 订单下单时间,格式“yyyy-MM-dd HH:mm:ss” |
1.3 请求示例
schema = json
param = {
"company": "ems",
"number": "1136281381675",
"from": "广东省深圳市南山区",
"to": "北京市朝阳区",
"key": "XXX ",
"parameters": {
"callbackurl": "您的回调接口的地址,如http://www.您的域名.com/kuaidi?callbackid=...",
"salt": "*",
"phone": "",
"ordertime": "2020-12-31 08:09:00"
}
}
1.4 订阅返回结果
字段名称 | 类型 | 是否必填 | 字段含义 |
---|---|---|---|
result | Boolean | 是 | true表示成功,false表示失败 |
returnCode | string | 是 | 返回状态码,详细见1.6附表 |
message | string | 是 | 状态信息 |
1.5 订阅响应报文示例(json格式)
{
"result": true,
"returnCode": "200",
"message":