检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API列表 调用前须知 视觉定位 空间位置追踪与渲染 导航 事件管理 SDK内部派发事件 父主题: WebARSDK使用手册
API列表 调用前准备工作 视觉定位 事件 日志 其他 父主题: XRLightSDK使用手册
设备或者用户唯一标识。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 X-Auth-Token 否 String 参数解释: IAM Token,和Authorization二选一必传。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 Authorization
服务会记录哪些用户行为数据 API使用 API是否支持集成到第三方产品中 API是否存在对调用IP数量的限制 其他问题 KooMap服务与其他服务的关系
其他问题 KooMap服务与其他服务的关系
空间定位 视觉定位 父主题: API
空间导航 AR导航 父主题: API
API是否支持集成到第三方产品中 如果用户需要将KooMap服务集成到第三方系统用于二次开发,请使用API方式访问KooMap服务,具体操作和描述请参见如何调用API。 父主题: API使用
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对AR导航接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应
构造请求 本节介绍REST API请求的组成,并以调用KooMap的AR导航接口说明如何调用API。 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求
认证鉴权 调用接口有如下两种认证方式,您可以根据实际情况选择其中一种进行认证鉴权。 Token认证:指通过Token认证调用请求,适用于AR地图运行服务。 AK/SK认证:指通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,适用于AR地图运行服务。
附录 状态码 错误码
状态码 常用状态码请参见表1。 表1 请求状态返回码 状态码 描述 说明 200 OK 服务器已成功处理了请求。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,
事件 接口列表 表1 事件接口列表 接口 描述 参数名 参数类型 参数说明 返回值 addEvent 侦听事件。 evtName string 事件ID。 根据实际情况选择Vps定位结果事件ID、Vps状态事件ID或scene实例事件ID。 void cb Function 侦听到事件后,触发的回调函数。
日志 接口列表 表1 日志接口列表 接口 描述 参数名 参数类型 参数说明 返回值 initLogger 初始化日志模块 logger ILog 日志的实例 void setIsSaveLog 日志存储 isSave boolean 是否存储日志 void setLogOutputLevel
其他 接口列表 表1 其他接口列表 接口 描述 参数名 参数类型 参数说明 返回值 requestNavi 请求导航路径。 utmCode string 当前utm区域。 void from number[3] 导航出发点utm坐标。 to number[3] 导航目的地utm坐标。
导航 导航需要使用到的接口如表1所示。 表1 导航接口列表 接口 描述 参数名 参数类型 参数说明 返回值 searchPoi POI智能搜索。 searchData { floor?: string; address?: string; title?: string; tag?:
事件管理 事件管理使用到的接口如表1所示。 表1 事件管理接口列表 接口 描述 参数名 参数类型 参数说明 返回值 dispatchEvent 事件派发。 strId string 侦听事件id。 void data { [key: string]: DataType } 携带的数据。
视觉定位 接口列表 视觉定位需要使用的接口如表1所示。 表1 视觉定位接口列表 接口 描述 参数名 参数类型 参数说明 返回值 getToken 向服务器请求签名。 - - - Promise<any> setAKSK 验证租户身份信息。 requestParams { AK: string;
调用前准备工作 XRLightSDK封装类名为“XRClient”,所有API均直接通过类“XRClient”来调用,无需实例化。 在调用SDK前,需在文件头部引入XRClient类。 import { XRClient } from "../../SDK/XRClient"; 父主题: