# AR导航 - StartNavi
#### 功能介绍
AR导航是新型的地图导航方法，基于摄像头实时捕捉的实景画面，将地图导航信息通过数字内容的形态叠加在实景画面中，生成虚拟的3D导航指引。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/KooMap/doc?api=StartNavi)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-koomap/koomap_06_0014.html)。
#### URI
POST /v1/algo/navi
#### 请求参数
表1请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                    |
|:---|:---|:---|:---|
| X-Trace-Id    | 否    | String | **参数解释：** 追踪请求ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                        |
| App-Id        | 否    | String | **参数解释：** 场景模板分配的app_id。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                 |
| Uuid          | 是    | String | **参数解释：** 设备或者用户唯一标识。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                    |
| X-Auth-Token  | 否    | String | **参数解释：** IAM Token，和Authorization二选一必传。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| Authorization | 否    | String | **参数解释：** AK/SK签名结果，和X-Auth-Token二选一必传。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。  |
   
表2请求Body参数 
| 参数      | 是否必选 | 参数类型                                          | 描述                                                          |
|:---|:---|:---|:---|
| payload | 是    | [payload] object | **参数解释：** 导航服务请求体，包含了用于导航的起始位置、终点位置和地区UTM编码。 **约束限制：** 不涉及。 |
   
 表3payload 
| 参数   | 是否必选 | 参数类型                                    | 描述                                                                                                                 |
|:---|:---|:---|:---|
| from | 是    | [from] object | **参数解释：** 起始位置，包含坐标信息。 **约束限制：** 不涉及。                                                                              |
| to   | 是    | [to] object     | **参数解释：** 终点位置，包含坐标信息。 **约束限制：** 不涉及。                                                                              |
| utm  | 是    | String                                  | **参数解释：** 地区UTM编码，一种用于将地球表面上的地理位置投影到二维平面上的方法，编码用于快速识别和定位到UTM网格中的特定区域。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
 表4from 
| 参数 | 是否必选 | 参数类型   | 描述                                                                 |
|:---|:---|:---|:---|
| x  | 是    | String | **参数解释：** 空间坐标系统，x坐标。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| y  | 是    | String | **参数解释：** 空间坐标系统，y坐标。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| z  | 是    | String | **参数解释：** 空间坐标系统，z坐标。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
 表5to 
| 参数 | 是否必选 | 参数类型   | 描述                                                                 |
|:---|:---|:---|:---|
| x  | 是    | String | **参数解释：** 空间坐标系统，x坐标。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| y  | 是    | String | **参数解释：** 空间坐标系统，y坐标。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| z  | 是    | String | **参数解释：** 空间坐标系统，z坐标。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码：200**
表6响应Header参数 
| 参数         | 参数类型   | 描述                               |
|:---|:---|:---|
| X-Trace-Id | String | **参数解释：** 追踪请求ID。 **取值范围：** 不涉及。 |
   
表7响应Body参数 
| 参数     | 参数类型                                               | 描述                                                                                                          |
|:---|:---|:---|
| result | Integer                                            | **参数解释：** 接口返回的状态码，用于表示导航请求的结果。 **取值范围：** - 0：导航成功。 - 1：起始地点无效。 - 2：目标地点无效。 - 3：未连接 。 - 6：栅格数据。 - 8：途径地点无效。 |
| path   | Array of [path] objects | **参数解释：** 返回的路径信息。 **取值范围：** 不涉及。                                                                           |
   
 表8path 
| 参数       | 参数类型    | 描述                                                                                                                                                   |
|:---|:---|:---|
| linkID   | String  | **参数解释：** 路段ID，用于唯一标识一个路段。 **取值范围：** 不涉及。                                                                                                            |
| x        | Float   | **参数解释：** x坐标，三维空间中的地理位置。 **取值范围：** 不涉及。                                                                                                             |
| y        | Float   | **参数解释：** y坐标，三维空间中的地理位置。 **取值范围：** 不涉及。                                                                                                             |
| z        | Float   | **参数解释：** z坐标，三维空间中的地理位置。 **取值范围：** 不涉及。                                                                                                             |
| floor    | String  | **参数解释：** 楼层信息。 **取值范围：** 不涉及。                                                                                                                       |
| building | String  | **参数解释：** 楼层的描述。 **取值范围：** 不涉及。                                                                                                                      |
| status   | Integer | **参数解释：** 表示路段的导航状态或类型。 **取值范围：** - 0：未经计算。 - 1：直行。 - 2：左转。 - 3：左前方。 - 4：左后方。 - 5：右转。 - 6：右前方。 - 7：右后方。 - 8：直梯。 - 9：终止点。 - 10：扶梯。 - 11：楼梯。 - 12：途经点。 |
   
#### 请求示例
navi请求体示例。
```
POST https://{Endpoint}.com/v1/algo/navi
{
  "payload" : {
    "from" : {
      "x" : "xxx",
      "y" : "xxx",
      "z" : "xxx"
    },
    "to" : {
      "x" : "xxx",
      "y" : "xxx",
      "z" : "xxx"
    },
    "utm" : "51N"
  }
}
```
#### 响应示例
无
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 空间导航服务请求成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koomap/ErrorCode.html)。