车辆信息同步 最后更新时间: 2020年12月15日
法律声明
版权所有©2019,高德集团。保留一切权利。本文档包含的所有内容除特别声明之外,版权均属于高德集团所有,受《中华人民共和国著作权法》及相关法律法规和中国加入的所有知识产权方面的国际条约的保护。未经本公司书面许可,任何单位和个人不得以任何方式(电子或机械,包括影印)翻印或转载本文档的任何部分,否则将视为侵权,高德集团保留依法追究其法律责任的权利。高德地图API 的一切有关权利属于高德集团所有。本文档并不代表供应商或其代理的承诺,高德集团可在不作任何申明的情况下对本文档内容进行修改。本文档中所涉及的软件产品及其后续升级产品均由高德集团制作并负责全权销售。本文档中提到的其它公司及其产品的商标所有权属于该商标的所有者。
高德地图API 欢迎用户的任何建议或意见。
前言
本文主要对车辆信息传输规范进行介绍,包括信息传输方式、协议、频率、具体信息等内容.注意:
- 接口URL示例中,使用<用户Key>(含尖括号),请替换为用户在lbs.amap.com中申请的Key.
- 在使用出行解决方案「附近运力展示」、「批量接驾计算」、「轨迹查询」等服务前,请优先使用本接口同步车辆位置.
接口使用说明
车辆信息同步接口
功能概述
本接口用于车辆位置的实时同步,合作方可根据业务实际情况,按照2s~5s的固定频率通过此接口上传车辆位置、状态等信息.
请求地址
https://tsapi.amap.com/v1/data/vehicle?key=
请求方法
POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 合作方的appKey,在开放平台控制台申请 |
type | string | 是 | 固定值"vehicles" |
coordType | string | 否 | 上传车辆位置的坐标系:
不传情况下,默认值为gcj02 |
msgID | string | 是 | 消息唯一标识,用于重试的幂等性校验,建议使用UUID策略 |
time | long | 是 | 请求接口时的服务端时间,Unix时间戳,精确到毫秒值 |
data | json | 是 | 请求的数据体 |
-vehicles | arr[] | 是 | 车辆信息数组,最多支持上传10个元素 |
--vehicleID | string | 是 | 车辆唯一标识,允许使用数字、字母、英文横线,如"BJ-A888888" 业务若不存在车辆ID,可以使用司机ID 请务必确保该标识唯一,否则会导致轨迹数据混乱 |
--vehicleType | string | 是 | 车辆类型,根据业务情况自行定义枚举,例如:
取值范围[1,200]该值影响「附近运力展示」、「批量接驾计算」使用 |
--state | int | 是 | 车辆状态:
该值影响「附近运力展示」、「批量接驾计算」、「轨迹查询」使用 |
--carryMode | int | 是 | 车辆载客模式:
该值影响「批量接驾计算」使用 |
--city | string | 是 | 城市编码,如北京市编码为010 |
--locationtype | int | 是 | 定位类型:
该值影响「轨迹查询」纠偏效果 |
--location | string | 是 | 定位坐标,车辆所在位置 经纬度之间用英文逗号分隔,保留小数点后6位,如"116.397432,39.908599" |
--accuracy | double | 是 | 定位精度,标识定位坐标的横向误差 保留小数点后3位 该值影响「轨迹查询」纠偏效果 |
--direction | double | 是 | 定位方向,标识定位时刻的朝向 顺时针[0,360]范围内取值,0表示正北方向,保留小数点后4位 该值影响「轨迹查询」纠偏效果 |
--speed | double | 是 | 定位速度,标识定位时刻的瞬时速度 单位 km/h,保留小数点后3位 该值影响「轨迹查询」纠偏效果 |
--height | double | 是 | 定位高度,标识定位时刻的海拔 单位 m,保留小数点后3位 该值影响「轨迹查询」纠偏效果 |
--deviceTime | long | 是 | 设备获取定位信息时的系统时间,Unix时间戳,精确到毫秒值 该值影响「轨迹查询」纠偏效果 |
--timestamp | long | 是 | 设备获取定位信息时的网络时间,Unix时间戳,精确到毫秒值 轨迹查询时,以此时间作为定位点的时间戳,查询时间区间需要此时间一致、 建议: 从服务端转发同步,可以使用服务端时间 从客户端直接同步,可以使用定位返回的网络时间 该值影响「轨迹查询」使用 |
--orderID | string | 否 | 当车辆正在服务的订单ID,如果没有正在服务的订单,该字段可不传 只允许大写字母、小写字母、数字 拼车场景下,请将车辆信息同步两次,仅订单ID不一致即可 该值影响「轨迹查询」使用 |
--destination | string | 否 | 订单目的地坐标,保留小数点后6位 |
--seats | int | 否 | 车辆的座位数 |
示例:
curl
-X POST 'https://tsapi.testing.amap.com/v1/data/vehicle?key=#'
-H 'Content-Type: application/json'
-d '
{
"msgID": "68753A44-4D6F-1226-9C60-0050E4C00067",
"type": "vehicles",
"key": "2di95fe01a20ede3018a1c77d4a71078",
"time": 1480070422321,
"data": {
"vehicles": [{
"vehicleID": "BJ-A99999",
"vehicleType": 1,
"state": 1,
"locationtype": 1,
"location": "116.473195,39.993253",
"accuracy": 60.001,
"direction": 360.000,
"speed": 20.003,
"height": 1000.342,
"deviceTime": 1480070222233,
"timestamp": 1480070222233,
"carryMode": 1,
"orderID": "test001"
"destination": "116.397432,39.908599",
"seats": 5,}]}}
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | string | 错误码 |
errmsg | string | 错误描述 |
errdetail | string | 错误详情 |
示例:
{
"errcode":0,
"errmsg":"OK"}
附录
错误码
序号 | errcode | errmsg | 状态描述 | 问题排查策略 |
---|---|---|---|---|
1 | 10000 | OK | 请求正常 | 请求正常 |
2 | 10001 | INVALID_USER_KEY | key不正确或过期 | 发起请求时,传入的key不正确或者过期 |
3 | 10002 | SERVICE_NOT_AVAILABL E,Solution URL "http://lbs.a map.com/api/webservice/inf o/" | 没有权限使用相应 的服 务或者请求 接口的路径 拼写 错误 |
1.没有权限使用相应的服务,例如:申请了WEB定位功能的key,却使用该key访问逆地理编码功能时,就会返回该错误。反之亦然 2.请求接口的路径拼写错误 |
4 | 10003 | DAILY_QUERY_OVER_LIMI T,Solution URL "http://lbs.am ap.com/api/webservice/info/" | 访问已超出日访问 量 | 日访问量超限,被系统自动封停,第二天0:0 0会自动解封 |
5 | 10004 | ACCESS_TOO_FREQUEN T,Solution URL"http://lbs.am ap.com/api/webservice/info/" | 单位时间内访问过 于频 繁 | 单位时间内(1分钟)访问量超限,被系统 自 动封停,下一分钟自动解封。 |
6 | 10005 | INVALID_USER_IP | IP白名单出错,发 送请求的服务器IP 不在IP白名单内 | 在LBS官网控制台设置的IP白名单不正确。 白名单中未添加对应服务器的出口IP。可 到"控制台>配置"中设定IP白名单 |
7 | 10006 | INVALID_USER_DOMAIN | 绑定域名无效 | 为Key绑定的域名无效,需要在官网控制台 重 新设置 |
8 | 10007 | INVALID_USER_SIGNATURE | 数字签名未通过验 证 | 数字签名未通过。在key控制台中,开启 了"数字签名"功 能,但没有按照指定算法生 成"数字签名 |
9 | 10008 | INVALID_USER_SCODE | MD5安全码未通过 验证 | 需要判定key绑定的SHA1,package是否与sd k包里的一致 |
10 | 10009 | USERKEY_PLAT_NOMATCH | 请求key与绑定平 台不 符 | 请求中使用的key与绑定平台不符,例如: 申 请的是JS A PI的key,却用来调Web服务 接口 |
11 | 10010 | IP_QUERY_OVER_LIMIT,So lution URL "http://lbs.amap.c om/api/webservice/info/" | IP访问超限 | 未设定IP白名单的开发者使用Key发起请 求, 从单个IP向 服务器发送的请求次数超 出限 制,被系统自动封停 |
12 | 10011 | NOT_SUPPORT_HTTPS | 服务不支持https请 求 | 服务不支持https请求,如果需要申请支持, 请提交工单联系我们 |
13 | 10012 | INSUFFICIENT_PRIVILEGE S | 权限不足,服务请 求被 拒绝 | 由于不具备请求该服务的权限,所以服务被 拒绝 |
14 |
10013 | USER_KEY_RECYCLED | Key被删除 | Key被删除后无法正常使用 |
15 | 10014 | QPS_HAS_EXCEEDED_TH E_LIMIT | QPS超限 | QPS超出限制,超出部分的请求被拒绝。限 流阈值内的请求依旧会正常返回 |
16 |
10015 | GATEWAY_TIMEOUT | 受单机QPS限流限 制 | 受单机QPS限流限制时出现该问题,建议降 低请求的QPS或在控制台提工单联系我们 |
17 | 10016 | SERVER_IS_BUSY | 服务器负载过高 | 服务器负载过高,请稍后再试 |
18 | 10017 | RESOURCE_UNAVAILABLE |
所请求的资源不可用 | 所请求的资源不可用 |
19 | 10019 | CQPS_HAS_EXCEEDED_THE_LIMIT | 使用的某个服务总QPS超限 | |
20 | 10020 | CKQPS_HAS_EXCEEDED_THE_LIMIT | 某个Key使用某个服务接口QPS超出限制 | |
21 | 10021 | CIQPS_HAS_EXCEEDED_THE_LIMIT | 来自于同一IP的访问,使用某个服务QPS超出限制 | |
22 | 10022 | CIKQPS_HAS_EXCEEDED_THE_LIMIT | 某个Key,来自于同一IP的访问,使用某个服务QPS 超出限制 |
|
23 | 10023 | KQPS_HAS_EXCEEDED_THE_LIMIT | 某个KeyQPS超出限制 | |
24 | 20000 | INVALID_PARAMS | 请求参数非法 | 请求参数的值没有按照规范要求填写。例如,某参数值域范围为[1,3],开发者误填了"4" |
25 | 20001 | MISSING_REQUIRED_PARAMS | 缺少必填参数 | 缺少接口中要求的必填参数 |
26 | 20002 | ILLEGAL_REQUEST | 请求协议非法 | 请求协议非法 |
27 | 20003 | UNKNOWN_ERROR | 其他未知错误 | 其他未知错误 |
28 | 20011 | INSUFFICIENT_ABROAD_PRIVILEGES | 查询坐标或规划点(包括起点、终点、途经点)在海 外,但没有海外地图权限 | |
29 | 20012 | ILLEGAL_CONTENT | 查询信息存在非法内容 | |
30 | 20051 | TERMINAL_NOT_FOUND | 设备不存在,即查询使用的车辆ID没有通过 data/vehicle上传 | |
31 | 20052 | TRACK_NOT_FOUND | 轨迹不存在,即查询使用的订单ID没有通过 data/vehicle上传 | |
32 | 20800 | OUT_OF_SERVICE | 规划点(包括起点、终点、途经点)不在中国陆地范 围内 | |
33 | 20801 | NO_ROADS_NEARBY | 划点(起点、终点、途经点)附近搜不到路 | |
34 | 20802 | ROUTE_FAIL | 路线计算失败,通常是由于道路连通关系导致 | |
35 | 20803 | OVER_DIRECTION_RANGE | 起点终点距离过长 | |
36 | 300** | ENGINE_RESPONSE_DATA_ERROR | 服务响应失败 | 出现3开头的错误码,建议先检查传入参数是否正确,若无法解决,请详细描述错误复现信息,提工单给我们 |