本产品中所有开放的API,按照功能目录分类,将API链接和API描述罗列出来。

项目管理

API 描述
分页查询项目列表 调用ListProject获取所有项目列表。
查询项目信息 调用DetailProject获取指定项目信息。
新增项目 调用AddProject创建新项目。
更新项目名称 调用UpdateProject更新指定的项目信息
删除项目 调用DropProject删除指定项目

主场景管理

API 描述
分页查看场景列表 调用ListScene获取指定项目下的所有主场景列表。
查看场景详情 调用DetailScene获取指定主场景信息。
添加场景 调用AddScene在指定项目下创建特定类型的主场景。
更新场景名称 调用UpdateScene更新指定的主场景信息
删除场景 调用DropScene删除指定主场景

子场景管理

API 描述
分页查看子场景列表 调用ListSubScene获取指定主场景下的所有子场景列表。
查看子场景信息 调用DetailSubScene获取指定子场景信息。
新增子场景 调用AddSubScene在指定的主场景下添加新的子场景。
获取OSS授权 调用GetOssPolicy获取OSS授权信息,获取授权后使用OSS SDK往指定路径上传图片或视频文件,上传完后直接调用LinkImage接口往子场景中添加图片。
关联图片到子场景 调用LinkImage关联图片或视频到子场景,目前一个子场景只能关联一张图片或者一个视频。
更新子场景名称 调用UpdateSubScene更新指定的子场景信息。
删除子场景 调用DropSubScene删除指定的子场景。
查看子场景下预处理及切图任务状态 调用GetSubSceneTaskStatus查看子场景下预处理及切图任务状态。

模型标注

API 描述
获取原始标注信息 调用GetOriginLayoutData获取原始标注信息。
获取最新标注信息 调用GetLayoutData获取最新标注信息,标注时使用。
更新标注信息 调用UpdateLayoutData更新标注信息,标注后可以使用此接口保存标注信息。
获取关联信息 调用UpdateLayoutData获取关联信息,标注时使用。
获取单图的关联信息 调用GetSingleConnData根据指定子场景获取与其相关的关联数据。
更新关联信息 调用UpdateConnData更新关联信息,标注时使用,保存最新的关联数据。
相对位置提交 调用AddRelativePosition提交相对位置关系。

算法处理、重建、发布

API 描述
图片矫正 调用RectifyImage对输入的图片进行垂直矫正处理。
获取矫正后图片 调用GetRectifyImage获取矫正后的图片,需要通过GetTaskStatus获取Status为succeed后才可调用成功。
墙线预测 调用PredictionWallLine对输入的图片进行垂直矫正处理,需要通过GetTaskStatus获取Status来确认墙线预的任务状态。
图片预处理 调用PredImage对子场景发起图片预处理,图片预处理包括图片垂直矫正、墙线预测、门预测等处理,如门预测或切图失败时,可调用此接口发起重试。
模型重建 调用LabelBuild发起3D模型重建任务,通过GetSceneBuildTaskStatus查询3D模型重建的任务状态。
查询任务状态 调用GetTaskStatus查询任务状态,可以查询所有类型的任务状态。
查询场景重建任务状态 调用GetSceneBuildTaskStatus查询3D模型重建的任务状态。
预览 调用TempPreview获取预览链接。
查询预览任务状态 调用TempPreviewStatus查询预览任务的状态。

热点交互

API 描述
获取系统配置信息 调用GetWindowConfig获取系统配置信息,预览及后处理时使用。
获取热点标注信息 调用GetHotspotTag获取热点标注信息,后处理时使用。
查询热点标注配置 调用GetHotspotConfig查询热点标注配置,后处理时使用。
保存热点标注配置 调用SaveHotspotConfig保存热点标注配置,后处理时使用。
保存热点标注信息 调用SaveHotspotTag保存热点标注信息,后处理时使用。
发布热点信息 调用PublishHotspot发布热点标注信息,后处理时使用。