# HMS花瓣地图 HMS花瓣地图连接器包含"路径规划-步行"、"路径规划-骑行"和"路径规划-驾车"等执行动作。 #### 连接参数 HMS花瓣地图连接器使用APIkey认证，创建HMS花瓣地图连接时连接参数说明如[表1]所示。 表1连接参数说明 | 名称 | 必填 | 说明 | 示例值/默认值 | |:---|:---|:---|:---| | 连接名称 | 是 | 设置连接名称。 | HMS花瓣地图连接 | | 描述 | 否 | 对于连接的信息描述说明。 | description | | key | 是 | API密钥。 | 登录[https://www.tianapi.com](https://www.tianapi.com/)后，注册账号并登录，单击"控制台"进入。 - 单击"我的密钥"可以查看API密钥。 - 单击"数据管理 \> 我的密钥KEY"可以查看API密钥。 | #### 路径规划-步行 在步行条件下进行路径规划。 - 输入参数 用户配置路径规划-步行执行动作，相关参数说明如[表2]所示。 表2路径规划-步行输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 起点经度 | 是 | 起点经度，取值范围：\[-180，180\]。 | | 起点纬度 | 是 | 起点纬度，取值范围：\[-90，90\]。 | | 终点经度 | 是 | 终点经度，取值范围：\[-180，180\]。 | | 终点纬度 | 是 | 终点纬度，取值范围：\[-90，90\]。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表3]。 表3路径规划-步行输出参数说明 | 参数 | 说明 | |:---|:---| | 到目的地的规划路径 | 从起点到目的地的规划路径。如果没有结果，返回空数组。 | | 红绿灯个数 | 红绿灯个数。 | | 目的地在不同时区 | 目的地在不同时区。 | | 穿越国境线 | 穿越国境线。 | | 此路段包含私家/限制用途 | 此路段包含私家/限制用途。 | | 此路段经过崎岖道路 | 此路段经过崎岖道路。 | | 红绿灯 | 红绿灯。 | | 穿越（多条）国境线 | 穿越（多条）国境线。 | | 终点在限制区域 | 终点在限制区域。 | | overviewPolyline | 概述多段线。 | | 路线分段信息 | 路线分段信息。 | | 行驶时长 | 行驶时长，单位：秒。 | | Duration的文本描述 | Duration的文本描述。 | | durationInTraffic的文本描述 | durationInTraffic的文本描述。 | | 行驶时长 | 基于实时路况计算出来的行驶时长，单位：秒。 | | 行驶距离 | 行驶距离，单位：米。 | | 出发地经度 | 出发地经度。 | | 出发地纬度 | 出发地纬度。 | | startLocation对应的地址详情 | startLocation对应的地址详情。 | | Distance的文本描述 | Distance的文本描述。 | | steps | 路线分段信息。 | | Duration的文本描述 | Duration的文本描述。 | | 行驶距离 | 行驶距离，单位：米。 | | 路名 | 路名。 | | 行驶时长 | 行驶时长，单位：秒。 | | 出发地经度 | 出发地经度。 | | 出发地纬度 | 出发地纬度。 | | 文字指引 | 文字指引。 | | 当前步骤要执行的操作 | 当前步骤要执行的操作(左转，右转，执行等)。 | | Distance的文本描述 | Distance的文本描述。 | | 目的地经度 | 目的地经度。 | | 目的地纬度 | 目的地纬度。 | | 此路段的一系列坐标点 | 此路段的一系列坐标点（包含起点和终点坐标）。 | | 坐标点经度 | 坐标点经度。 | | 坐标点纬度 | 坐标点纬度。 | | 道路方向 | 道路方向 0：双向 1：正向 2：反向。 | | 路况信息 | 路况信息。 | | 行驶距离 | 行驶距离，单位：米。 | | 路况状态 | 路况状态。取值包括：0：未知 1：畅通 2：缓行 3：拥堵 4：严重拥堵。 | | 路段的形状坐标 | 路段的形状坐标。 | | 路段坐标经度 | 路段坐标经度。 | | 路段坐标纬度 | 路段坐标纬度。 | | 目的地经度 | 目的地经度。 | | 目的地纬度 | 目的地纬度。 | | endLocation对应的地址详情 | endLocation对应的地址详情。 | | 西南角位置经度 | 西南角位置经度。 | | 西南角位置纬度 | 西南角位置纬度。 | | 东北角的位置经度 | 东北角的位置经度。 | | 东北角的位置纬度 | 东北角的位置纬度。 | | 此路段含收费站 | 此路段含收费站。 | | 途径轮渡 | 途经轮渡。 | | 此路段含有阶梯 | 此路段含有阶梯。 | | 返回码 | 返回码。 | | 返回值描述 | 返回值描述。 | #### 路径规划-骑行 在骑行条件下进行路径规划。 - 输入参数 用户配置路径规划-骑行执行动作，相关参数说明如[表4]所示。 表4路径规划-骑行输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 起点经度 | 是 | 起点经度，取值范围：\[-180，180\]。 | | 起点纬度 | 是 | 起点纬度，取值范围：\[-90，90\]。 | | 终点经度 | 是 | 终点经度，取值范围：\[-180，180\]。 | | 终点纬度 | 是 | 终点纬度，取值范围：\[-90，90\]。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表5]。 表5路径规划-骑行输出参数说明 | 参数 | 说明 | |:---|:---| | 到目的地的规划路径 | 从起点到目的地的规划路径。如果没有结果，返回空数组。 | | 红绿灯个数 | 红绿灯个数。 | | 目的地在不同时区 | 目的地在不同时区。 | | 穿越国境线 | 穿越国境线。 | | 此路段包含私家/限制用途 | 此路段包含私家/限制用途。 | | 此路段经过崎岖道路 | 此路段经过崎岖道路。 | | 红绿灯 | 红绿灯。 | | 穿越（多条）国境线 | 穿越（多条）国境线。 | | 终点在限制区域 | 终点在限制区域。 | | overviewPolyline | 概述多段线。 | | 路线分段信息 | 路线分段信息。 | | 行驶时长 | 行驶时长，单位：秒。 | | Duration的文本描述 | Duration的文本描述。 | | durationInTraffic的文本描述 | durationInTraffic的文本描述。 | | 行驶时长 | 基于实时路况计算出来的行驶时长，单位：秒。 | | 行驶距离 | 行驶距离，单位：米。 | | 出发地经度 | 出发地经度。 | | 出发地纬度 | 出发地纬度。 | | startLocation对应的地址详情 | startLocation对应的地址详情。 | | Distance的文本描述 | Distance的文本描述。 | | steps | 路线分段信息。 | | Duration的文本描述 | Duration的文本描述。 | | 行驶距离 | 行驶距离，单位：米。 | | 路名 | 路名。 | | 行驶时长 | 行驶时长，单位：秒。 | | 出发地经度 | 出发地经度。 | | 出发地纬度 | 出发地纬度。 | | 文字指引 | 文字指引。 | | 当前步骤要执行的操作 | 当前步骤要执行的操作(左转，右转，执行等)。 | | Distance的文本描述 | Distance的文本描述。 | | 目的地经度 | 目的地经度。 | | 目的地纬度 | 目的地纬度。 | | 此路段的一系列坐标点 | 此路段的一系列坐标点（包含起点和终点坐标）。 | | 坐标点经度 | 坐标点经度。 | | 坐标点纬度 | 坐标点纬度。 | | 道路方向 | 道路方向 0：双向 1：正向 2：反向。 | | 路况信息 | 路况信息。 | | 行驶距离 | 行驶距离，单位：米。 | | 路况状态 | 路况状态。取值包括：0：未知 1：畅通 2：缓行 3：拥堵 4：严重拥堵。 | | 路段的形状坐标 | 路段的形状坐标。 | | 路段坐标经度 | 路段坐标经度。 | | 路段坐标纬度 | 路段坐标纬度。 | | 目的地经度 | 目的地经度。 | | 目的地纬度 | 目的地纬度。 | | endLocation对应的地址详情 | endLocation对应的地址详情。 | | 西南角位置经度 | 西南角位置经度。 | | 西南角位置纬度 | 西南角位置纬度。 | | 东北角的位置经度 | 东北角的位置经度。 | | 东北角的位置纬度 | 东北角的位置纬度。 | | 此路段含收费站 | 此路段含收费站。 | | 途径轮渡 | 途径轮渡。 | | 此路段含有阶梯 | 此路段含有阶梯。 | | 返回码 | 返回码。 | | 返回值描述 | 返回值描述。 | #### 路径规划-驾车 在驾车条件下进行路径规划。 - 输入参数 用户配置路径规划-驾车执行动作，相关参数说明如[表6]所示。 表6路径规划-驾车输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 起点经度 | 是 | 起点经度，取值范围：\[-180，180\]。 | | 起点纬度 | 是 | 起点纬度，取值范围：\[-90，90\]。 | | 终点经度 | 是 | 终点经度，取值范围：\[-180，180\]。 | | 终点纬度 | 是 | 终点纬度，取值范围：\[-90，90\]。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表7]。 表7路径规划-驾车输出参数说明 | 参数 | 说明 | |:---|:---| | 到目的地的规划路径 | 从起点到目的地的规划路径。如果没有结果，返回空数组。 | | 红绿灯个数 | 红绿灯个数。 | | 目的地在不同时区 | 目的地在不同时区。 | | 穿越国境线 | 穿越国境线。 | | 此路段包含私家/限制用途 | 此路段包含私家/限制用途。 | | 此路段经过崎岖道路 | 此路段经过崎岖道路。 | | 红绿灯 | 红绿灯。 | | 穿越（多条）国境线 | 穿越（多条）国境线。 | | 终点在限制区域 | 终点在限制区域。 | | overviewPolyline | 概述多段线。 | | 路线分段信息 | 路线分段信息。 | | 行驶时长 | 行驶时长，单位：秒。 | | Duration的文本描述 | Duration的文本描述。 | | durationInTraffic的文本描述 | durationInTraffic的文本描述。 | | 行驶时长 | 基于实时路况计算出来的行驶时长，单位：秒。 | | 行驶距离 | 行驶距离，单位：米。 | | 出发地经度 | 出发地经度。 | | 出发地纬度 | 出发地纬度。 | | startLocation对应的地址详情 | startLocation对应的地址详情。 | | Distance的文本描述 | Distance的文本描述。 | | steps | 路线分段信息。 | | Duration的文本描述 | Duration的文本描述。 | | 行驶距离 | 行驶距离，单位：米。 | | 路名 | 路名。 | | 行驶时长 | 行驶时长，单位：秒。 | | 出发地经度 | 出发地经度。 | | 出发地纬度 | 出发地纬度。 | | 文字指引 | 文字指引。 | | 当前步骤要执行的操作 | 当前步骤要执行的操作(左转，右转，执行等)。 | | Distance的文本描述 | Distance的文本描述。 | | 目的地经度 | 目的地经度。 | | 目的地纬度 | 目的地纬度。 | | 此路段的一系列坐标点 | 此路段的一系列坐标点（包含起点和终点坐标）。 | | 坐标点经度 | 坐标点经度。 | | 坐标点纬度 | 坐标点纬度。 | | 道路方向 | 道路方向 0：双向 1：正向 2：反向。 | | 路况信息 | 路况信息。 | | 行驶距离 | 行驶距离，单位：米。 | | 路况状态 | 路况状态。取值包括：0：未知 1：畅通 2：缓行 3：拥堵 4：严重拥堵。 | | 路段的形状坐标 | 路段的形状坐标。 | | 路段坐标经度 | 路段坐标经度。 | | 路段坐标纬度 | 路段坐标纬度。 | | 目的地经度 | 目的地经度。 | | 目的地纬度 | 目的地纬度。 | | endLocation对应的地址详情 | endLocation对应的地址详情。 | | 西南角位置经度 | 西南角位置经度。 | | 西南角位置纬度 | 西南角位置纬度。 | | 东北角的位置经度 | 东北角的位置经度。 | | 东北角的位置纬度 | 东北角的位置纬度。 | | 此路段含收费站 | 此路段含收费站。 | | 途径轮渡 | 途径轮渡。 | | 此路段含有阶梯 | 此路段含有阶梯。 | | 返回码 | 返回码。 | | 返回值描述 | 返回值描述。 | #### 批量算路-步行 在步行条件下批量计算路径。 - 输入参数 用户配置批量算路-步行执行动作，相关参数说明如[表8]所示。 表8批量算路-步行输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 起点经度 | 是 | 起点经度，取值范围：\[-180，180\]。 | | 起点纬度 | 是 | 起点纬度，取值范围：\[-90，90\]。 | | 终点经度 | 是 | 终点经度，取值范围：\[-180，180\]。 | | 终点纬度 | 是 | 终点纬度，取值范围：\[-90，90\]。 | | 文字指引/描述的语种 | 否 | 文字指引/描述的语种。 | | 所指示的特性 | 否 | 计算出的路径应避免所指示的特性。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表9]。 表9批量算路-步行输出参数说明 | 参数 | 说明 | |:---|:---| | 从起点到目的地的规划路径 | 从起点到目的地的规划路径。如果没有结果，返回空数组。 | | 距离矩阵结果每个单元格的信息 | 距离矩阵结果每个单元格的信息。 | | Duration的文本描述 | Duration的文本描述。 | | 行驶距离 | 行驶距离，单位：米。 | | Duration的文本描述 | Duration的文本描述。 | | 起点和终点进行路径规划计算的错误码 | 起点和终点进行路径规划计算的错误码，具体请参见错误码。 | | 行驶时长 | 行驶时长，单位：秒。 | | 返回码 | 返回码。 | | 返回值描述 | 返回值描述。 | | 起点地址详情 | 起点地址详情。 | | 目的地地址详情 | 目的地地址详情。 | #### 批量算路-骑行 在骑行条件下批量计算路径。 - 输入参数 用户配置批量算路-骑行执行动作，相关参数说明如[表10]所示。 表10批量算路-骑行输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 起点经度 | 是 | 起点经度，取值范围：\[-180，180\]。 | | 起点纬度 | 是 | 起点纬度，取值范围：\[-90，90\]。 | | 终点经度 | 是 | 终点经度，取值范围：\[-180，180\]。 | | 终点纬度 | 是 | 终点纬度，取值范围：\[-90，90\]。 | | 文字指引/描述语种 | 否 | 文字指引/描述的语种。 | | 所指示的特性 | 否 | 计算出的路径应避免所指示的特性。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表11]。 表11批量算路-骑行输出参数说明 | 参数 | 说明 | |:---|:---| | routes | 从起点到目的地的规划路径。如果没有结果，返回空数组。 | | trafficLightNum | 红绿灯个数。 | | dstInDiffTimeZone | 目的地在不同时区。 | | crossCountry | 穿越国境线。 | | hasRestrictedRoad | 此路段包含私家/限制用途。 | | hasRoughRoad | 此路段经过崎岖道路。 | | hasTrafficLight | 红绿灯。 | | crossMultiCountries | 穿越（多条）国境线。 | | dstInRestrictedArea | 终点在限制区域。 | | overviewPolyline | 概述多段线。 | | paths | 路线分段信息。 | | duration | 行驶时长，单位：秒。 | | durationText | Duration的文本描述。 | | durationInTrafficText | durationInTraffic的文本描述。 | | durationInTraffic | 基于实时路况计算出来的行驶时长，单位：秒。 | | distance | 行驶距离，单位：米。 | | lng | 出发地经度。 | | lat | 出发地纬度。 | | startAddress | startLocation对应的地址详情。 | | distanceText | Distance的文本描述。 | | steps | 路线分段信息。 | | durationText | Duration的文本描述。 | | distance | 行驶距离，单位：米。 | | roadName | 路名。 | | duration | 行驶时长，单位：秒。 | | lng | 出发地经度。 | | lat | 出发地纬度。 | | instruction | 文字指引。 | | action | 当前步骤要执行的操作(左转，右转，执行等)。 | | distanceText | Distance的文本描述。 | | lng | 目的地经度。 | | lat | 目的地纬度。 | | polyline | 此路段的一系列坐标点（包含起点和终点坐标）。 | | lng | 坐标点经度。 | | lat | 坐标点纬度。 | | orientation | 道路方向 0：双向 1：正向 2：反向。 | | traffic | 路况信息。 | | distance | 行驶距离，单位：米。 | | status | 路况状态。取值包括：0：未知 1：畅通 2：缓行 3：拥堵 4：严重拥堵。 | | polyline | 路段的形状坐标。 | | lng | 路段坐标经度。 | | lat | 路段坐标纬度。 | | lng | 目的地经度。 | | lat | 目的地纬度。 | | endAddress | endLocation对应的地址详情。 | | lng | 西南角位置经度。 | | lat | 西南角位置纬度。 | | lng | 东北角的位置经度。 | | lat | 东北角的位置纬度。 | | hasTolls | 此路段含收费站。 | | hasFerry | 途径轮渡。 | | hasStairs | 此路段含有阶梯。 | | returnCode | 返回码。 | | returnDesc | 返回值描述。 | | originAddresses | Origins的地址详情 | | destinationAddresses | Destinations的地址详情 | #### 批量算路-驾车 在驾车条件下批量计算路径。 - 输入参数 用户配置批量算路-驾车执行动作，相关参数说明如[表12]所示。 表12批量算路-驾车输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 起点经度 | 是 | 起点经度，取值范围：\[-180，180\]。 | | 起点纬度 | 是 | 起点纬度，取值范围：\[-90，90\]。 | | 终点经度 | 是 | 终点经度，取值范围：\[-180，180\]。 | | 终点纬度 | 是 | 终点纬度，取值范围：\[-90，90\]。 | | 预计出发时间 | 否 | 预计出发时间，必须是当前或者未来时间，不能是过去时间。 | | 时间预估模型 | 否 | 时间预估模型。0：best guess；1：路况差于历史平均水平；2路况优于历史平均水平。默认值为0。 | | 文字指引/描述语种 | 否 | 文字指引/描述的语种。 | | 所指示的特性 | 否 | 计算出的路径应避免所指示的特性。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表13]。 表13批量算路-驾车输出参数说明 | 参数 | 说明 | |:---|:---| | 从起点到目的地的规划路径 | 从起点到目的地的规划路径。如果没有结果，返回空数组。 | | 距离矩阵结果每个单元格的信息 | 距离矩阵结果每个单元格的信息。 | | Duration的文本描述 | Duration的文本描述。 | | 行驶距离 | 行驶距离，单位：米。 | | Duration的文本描述 | Duration的文本描述。 | | 错误码 | 起点和终点进行路径规划计算的错误码，具体请参见错误码。 | | 行驶时长 | 行驶时长，单位：秒。 | | 返回码 | 返回码。 | | 返回值描述 | 返回值描述。 | | 起点地址详情 | 起点地址详情。 | | 目的地地址详情 | 目的地地址详情。 |