前言
本文主要对推荐上车点服务进行介绍,包括信息传输方式、协议、具体信息等内容。
注意
-
本服务以HTTPS方式进行访问。
-
本接口为高级接口,默认不可调用,使用请与腾讯位置服务商务人员取得联系,开放调用配额后,即可使用。
-
接口中的参数key和调用示例中的
(含尖括号), 请使用您在https://lbs.qq.com/key.html中申请的key。 -
如无特殊说明,所有接口的输入参数和输出参数编码全部统一为UTF-8。
概述
提供获取乘客定位点或者选定锚定点附近的推荐上车点功能,辅助乘客优化上车点选择,返回结果列表。
推荐上车点涉及3个接口,针对不同场景设计:
普通场景中若定位点周围存在推荐上车点,则会返回相应信息,最大返回3个推荐上车点数据。若定位点周围不存在推荐上车点,则返回空。
机场、火车站中可以通过获取二级围栏推荐上车点接口获取上车点信息。
获取上车点前,场景区分可以通过获取命中的围栏信息接口判断,只有经纬度在围栏范围内,才会返回围栏信息。
推荐上车点服务
本接口用于查询普通道路,路边打车、上车场景(非机场、车站)的推荐上车点。
请求URL
URL: https://apis.map.qq.com/ws/tpp/v1/search/
Method: GET
请求参数
参数 | 必填 | 说明 | 示例 |
---|---|---|---|
key | 必 | 客户注册的访问webservice的key | key=xxx |
location | 必 | 定位点位置, 格式为:lat(纬度),lng(精度),纬度与精度用英文逗号分隔 | location=40.034852,116.319820 |
user_id | 必 | 用户ID,会根据用户ID优化返回结果 | user_id=13354689125876 |
output | 必 | 返回格式,支持json/jsonp,默认json | output=jsonp |
callback | 必 | 回调函数,jsonp方式回调函数,默认QQmap | callback=cb |
响应结果
名称 | 类型 | 必填 | 说明 | ||||
---|---|---|---|---|---|---|---|
status | int | 必 | 状态码,0正常返回,表示接受到正常信息 | ||||
message | string | 必 | 错误信息 | ||||
request_id | string | 必 | 请求ID | ||||
show_id | string | 否 | 展现ID,全局唯一,用户点击推荐上车点时,需同时回传该字段,做状态关联 | ||||
data | array | 必 | 接口返回信息,可能包含多个上车点 | ||||
title | string | 必 | 上车点名 | ||||
location | object | 必 | 上车点经纬度 | ||||
lat | double | 必 | 纬度 | ||||
lng | double | 必 | 经度 | ||||
id | string | 必 | 上车点ID,需全局唯一 | ||||
park_time | int | 否 | [保留字段,暂未启用]上车点可以停车接客时长,单位:秒 | ||||
score | double | 否 | [保留字段,暂未启用]上车点综合权重,后续根据点击日志调整 | ||||
distance | int | 否 | 到达上车点的步行距离,单位:米 | ||||
line_distance | int | 否 | 到达上车点的直线距离,单位:米 | ||||
status | int | 否 | 该推荐上车点的开通封闭状态(0=>上线、1=>下线) | ||||
adcode | int | 否 | 此推荐上车点所在城市区县编码 | ||||
ext | string | 否 | 扩展字段,待定 |
请求示例
Methond:GET
https://apis.map.qq.com/ws/tpp/v1/search?key=key&location=20.02592,110.30427&user_id=1555
响应示例
{
"status": 0,
"message": "successful",
"request_id": "71602b03bb3e218b26b3c255926c2f",
"data": [
{
"id": "668576539016481181",
"title": "大有营销公司",
"location": {
"lat": 20.02587,
"lng": 110.30416
},
"distance": 17,
"line_distance": 11,
"score": 17,
"park_time": -1,
"adcode": 460106,
"ext": "{\"cross\": 0}"
},
{
"id": "670837598787552058",
"title": "世贸北路/民声东路(路口)南侧",
"location": {
"lat": 20.026345,
"lng": 110.303955
},
"distance": 73,
"line_distance": 57,
"score": 73,
"park_time": -1,
"adcode": 460106,
"ext": "{\"cross\": 0}"
},
{
"id": "670837615951405899",
"title": "佳景国际-东门附近",
"location": {
"lat": 20.025392,
"lng": 110.304367
},
"distance": 73,
"line_distance": 59,
"score": 73,
"park_time": -1,
"adcode": 460106,
"ext": "{\"cross\": 0}"
}
]
}
场站上车点
通过传入用户位置坐标,查询其所在机场、火车站等大型枢纽的推荐上车点, 场站上车点中包含其所在场站信息(称一级围栏),场站中有指定上车点的楼层或子区域(二级围栏),其及具体的上车点。
请求URL
URL: https://apis.map.qq.com/ws/tls/v1/tpp/fences
Method: GET
请求参数
参数 | 必填 | 说明 | 示例 |
---|---|---|---|
key | 必 | 客户注册的访问webservice的key | key=xxx |
location | 必 | 定位点位置, 格式为:lat(纬度),lng(精度),纬度与精度用英文逗号分隔 | location=40.034852,116.319820 |
reqid | 必 | 请求id,需要全局唯一,推荐使用UUID生成 | reqid=b7be9806-0b13-11e9-9aed-6c92bf46a458 |
reqtime | 必 | 请求时间戳,调用接口时间。 单位:秒,需满足:UNIX时间戳+[-30min,30min] |
reqtime= |
ver | 可选 | 数据版本,可选值: 0 旧版,默认(不再维护) 1 新版, 数据持续更新,建议使用、切换 |
ver=1 |
output | 必 | 返回格式,支持json/jsonp,默认json | output=jsonp |
callback | 必 | 回调函数,jsonp方式回调函数,默认QQmap | callback=cb |
get_noparking | 可选 | 使用get_noparking=1开启限制停车区域查询,可返回定位点命中的限制停车区域和区域内合规上车点 限制停车区域优先级低于场站围栏,若同时命中则返回场站围栏数据 |
get_noparking=1 |
响应结果
名称 | 类型 | 必填 | 说明 | ||||||
---|---|---|---|---|---|---|---|---|---|
status | int | 必 | 状态码,0正常返回,表示接受到正常信息 | ||||||
message | string | 必 | 错误信息 | ||||||
data | object | 必 | 接口返回信息 | ||||||
status | int | 必 | 状态码,0正常返回,表示接受到正常信息 | ||||||
message | string | 必 | 错误信息 | ||||||
detail | object | 否 | 返回详细信息 | ||||||
hit_hub_of_traffic | int | 必 | 是否命中交通枢纽 1 : 命中交通枢纽 (或限制停车区域) 0:未命中,用户需要调用推荐上车点服务 |
||||||
data | object | 否 | 交通枢纽信息,仅hit_hub_of_traffic=1时才有此信息 | ||||||
name | string | 必 | 一级交通枢纽名称(或限制停车区域名称) | ||||||
category | string | 必 | POI类型 | ||||||
category_code | string | 必 | POI类型编码(命中限制停车区域时为998001) | ||||||
polygon | string | 必 | 交通枢纽围栏经纬度 | ||||||
sub_fence | array | 必 | 二级围栏信息,用于列表展示 | ||||||
name | string | 必 | 二级围栏名称 格式:一级围栏名称-二级围栏名称-二级围栏名称(或 “限制停车区域”-限制停车区域名称) 如:广东东站-广东东站-进站口(或 限制停车区域-福田口岸) |
||||||
id | string | 必 | 二级围栏id | ||||||
hit_sub_fence | array | 必 | 命中的二级围栏信息,如果未命中二级围栏则返回空数组 | ||||||
name | string | 必 | 二级围栏名称 | ||||||
id | string | 必 | 二级围栏id | ||||||
polygon | string | 必 | 交通枢纽围栏经纬度 | ||||||
data | array | 必 | 推荐上车点信息 | ||||||
title | string | 必 | 推荐上车点名称 | ||||||
location | object | 必 | 推荐上车点经纬度 | ||||||
lat | double | 必 | 纬度 | ||||||
lng | double | 必 | 经度 | ||||||
id | string | 必 | 上车点ID,需全局唯一 | ||||||
distance | long | 必 | 到达上车点的直线距离,单位:米 |
请求示例
响应示例
{
"status": 0,
"message": "query ok",
"data": {
"status": 0,
"message": "successful",
"request_id": "a7e774ff8c40d17a7c73745c8639b2",
"detail": {
"hit_hub_of_traffic": 1,
"data": {
"name": "广州南站",
"polygon": "22.984190,113.270655;22.984101,113.270891;22.984131,113.271143;22.985449,113.273225;22.985676,113.273278;22.987667,113.271878;22.987760,113.271817;22.987938,113.272235;22.988689,113.272106;22.990338,113.271441;22.991573,113.269993;22.991168,113.269327;22.993074,113.268201;22.993133,113.267943;22.993064,113.267707;22.992946,113.267514;22.994802,113.265755;22.994052,113.264317;22.989578,113.266366;22.988857,113.265347;22.988412,113.265293;22.985410,113.267761;22.985360,113.268297;22.986022,113.269381",
"sub_fence": [
{
"id": "GZ-GZSS-NQDDDT",
"name": "南区-到达大厅"
},
{
"id": "GZ-GZSS-NQP5KSJKQ",
"name": "南区-P5快速接客区"
},
... // 其他省略
],
"hit_sub_fence": [
{
"id": "GZ-GZSS-NQDDDT",
"name": "广州南站-南区-到达大厅",
"polygon": "22.984190,113.270655;22.984101,113.270891;22.984131,113.271143;22.985449,113.273225;22.985676,113.273278;22.987667,113.271878;22.987760,113.271817;22.987938,113.272235;22.988689,113.272106;22.990338,113.271441;22.986970,113.266484;22.985410,113.267761;22.985360,113.268297;22.986022,113.269381",
"data": [
{
"id": "671403941758034471",
"title": "广州南站-西侧-P5快速接客区",
"location": {
"lat": 22.990024,
"lng": 113.267211
},
"distance": 283
},
{
"id": "671403941758034486",
"title": "广州南站-北侧-P8停车场",
"location": {
"lat": 22.992275,
"lng": 113.268406
},
"distance": 493
}
]
}
... // 其他省略
],
"category": "基础设施:交通设施:火车站",
"category_code": 271016
}
}
}
}
场站上车点:获取二级围栏推荐上车点信息
请求URL
URL: https://apis.map.qq.com/ws/tls/v1/tpp/search
Method: GET
请求参数
参数 | 必填 | 说明 | 示例 |
---|---|---|---|
key | 必 | 客户注册的访问webservice的key | key=xxx |
fence_id | 必 | 二级围栏idy | fence_id=xxx |
location | 必 | 定位点位置, 格式为:lat(纬度),lng(精度),纬度与精度用英文逗号分隔 | location=40.034852,116.319820 |
reqid | 必 | 请求id,需要全局唯一,推荐使用UUID生成 | reqid=b7be9806-0b13-11e9-9aed-6c92bf46a458 |
reqtime | 必 | 请求时间戳,调用接口时间。 单位:秒,需满足:UNIX时间戳+[-30min,30min] |
reqtime= |
ver | 可选 | 数据版本,可选值: 0 旧版,默认(不再维护) 1 新版, 数据持续更新,建议使用、切换 |
ver=1 |
output | 必 | 返回格式,支持json/jsonp,默认json | output=jsonp |
callback | 必 | 回调函数,jsonp方式回调函数,默认QQmap | callback=cb |
响应结果
名称 | 类型 | 必填 | 说明 | ||||
---|---|---|---|---|---|---|---|
status | int | 必 | 状态码,0正常返回,表示接受到正常信息 | ||||
message | string | 必 | 错误信息 | ||||
data | object | 必 | 接口返回信息 | ||||
status | int | 必 | 状态码,0正常返回,表示接受到正常信息 | ||||
message | string | 必 | 错误信息 | ||||
detail | object | 否 | 返回详细信息 | ||||
request_id | int | 必 | 请求ID | ||||
name | string | 必 | 二级围栏名称 | ||||
polygon | string | 必 | 交通枢纽围栏经纬度 | ||||
data | array | 必 | 推荐上车点信息 | ||||
title | string | 必 | 推荐上车点名称 | ||||
location | object | 必 | 推荐上车点经纬度 | ||||
lat | double | 必 | 纬度 | ||||
lng | double | 必 | 经度 | ||||
id | string | 必 | 上车点ID,需全局唯一 | ||||
distance | long | 必 | 到达上车点的直线距离,单位:米 | ||||
park_time | int | 否 | 上车点可以停车接客时长,单位:秒 | ||||
score | double | 否 | 上车点综合权重,后续根据点击日志调整 | ||||
status | int | 否 | 该推荐上车点的开通封闭状态(0=>上线、1=>下线) | ||||
ext | string | 否 | 扩展字段,待定 |
请求示例
响应示例
{
"status": 0,
"message": "queryok",
"data": {
"status": 0,
"message": "success",
"detail": {
"request_id": "110_304270_20_025920_1547024444_3",
"name": "T1航站楼",
"polygon": "30.638780,114.130858;30.638780,114.131931....",
"data": [{
"title": "T1A-地面P1停车场-出口",
"location": {
"lat": 20.02582,
"lng": 110.30418
},
"id": "110_304180_20_025820",
"distance": "34"
},{
"title": "T1A-地面P1停车场-一层落客区",
"location": {
"lat": 20.02539,
"lng": 110.30437
},
"id": "110_304370_20_025390",
"distance": "34"
}]
}
}
}
产品实际应用
当乘客上车点为火车站、机场打车场景时, 因部分场站要求以及场景限制等,需提供场站上车点选择功能供乘客确认选择期望的上车位置。
如上效果需结合 ws/tls/v1/tpp/fences 接口实现,具体请参考如下:
地图展示
地图展示主要包含所在围栏以及对应围栏的上车点信息,相关信息取自 hit_sub_fence 字段:
hit_sub_fence 字段下是对应二级围栏的详细信息,包含围栏范围和上车点信息等。
围栏绘制,通过hit_sub_fence下的polygon字段获取经纬度,可以通过端上的多边形覆盖物进行绘制展示。
上车点信息,通过hit_sub_fence下的data数组获取上车点列表,可以通过端上的点标记或文本标记进行绘制展示。
场站选择
二级围栏,通过列表的方式展示,相关的信息取自 sub_fence 字段:
sub_fence 字段是一个由多个二级围栏组成的数组,列表主要展示围栏名称
围栏名称接结构:一级围栏名称-二级围栏名称-二级围栏名称
一级围栏名称:代表当前所在场站的一级围栏,一般不做展示,可以忽略。
第一个二级围栏名称:用于列表聚类,关联第二个二级围栏名称。
第二个二级围栏名称:关联第一个二级围栏名称,级联展示对应的二级围栏。
当调整二级围栏时,需通过对应的围栏id调用 ws/tls/v1/tpp/search 接口获取新的上车点。
附录
如需查询返回值中的status和message的具体对应关系,请查看文档《开放平台错误对照表》。