本产品中所有开放的API,按照功能目录分类,将API链接和API描述罗列出来。
项目管理
API | 描述 |
---|---|
分页查询项目列表 | 调用ListProject获取所有项目列表。 |
查询项目信息 | 调用DetailProject获取指定项目信息。 |
新增项目 | 调用AddProject创建新项目。 |
更新项目名称 | 调用UpdateProject更新指定的项目信息 |
删除项目 | 调用DropProject删除指定项目 |
主场景管理
API | 描述 |
---|---|
分页查看场景列表 | 调用ListScene获取指定项目下的所有主场景列表。 |
查看场景详情 | 调用DetailScene获取指定主场景信息。 |
添加场景 | 调用AddScene在指定项目下创建特定类型的主场景。 |
更新场景名称 | 调用UpdateScene更新指定的主场景信息 |
删除场景 | 调用DropScene删除指定主场景 |
模型重建 | 调用LabelBuild创建3D模型重建任务 |
查询场景重建任务状态 | 调用GetSceneBuildTaskStatus查询场景重建任务状态 |
预览 | 调用TempPreview,在重建完成后可以调用此预览接口获取预览链接 |
查询预览任务状态 | 调用TempPreviewStatus查询预览任务状态,调用TempPreview后可以使用此接口查看任务状态,当任务结束后才可以使用预览链接进行预览,需要在调用TempPreview接口后10分钟之内调用 |
场景发布 | 调用PublishScene创建场景发布任务 |
查询发布状态 | 调用PublishStatus查询发布任务状态 |
场景预览数据 | 调用GetHotspotSceneData根据预览token查询场景模型预览数据及场景模型点位信息 |
子场景管理
API | 描述 |
---|---|
分页查看子场景列表 | 调用ListSubScene获取指定主场景下的所有子场景列表。 |
查看子场景信息 | 调用DetailSubScene获取指定子场景信息。 |
新增子场景 | 调用AddSubScene在指定的主场景下添加新的子场景。 |
获取OSS授权 | 调用GetOssPolicy获取OSS授权信息,获取授权后使用OSS SDK往指定路径上传图片或视频文件,上传完后直接调用LinkImage接口往子场景中添加图片。 |
关联图片到子场景 | 调用LinkImage关联图片或视频到子场景,目前一个子场景只能关联一张图片或者一个视频。 |
更新子场景 | 调用UpdateSubScene更新指定的子场景信息。 |
删除子场景 | 调用DropSubScene删除指定的子场景。 |
回滚子场景 | 调用RollbackSubScene将已删除的子场景进行恢复(仅限全景图片类型可用)。 |
查看子场景下预处理及切图任务状态 | 调用GetSubSceneTaskStatus查看子场景下预处理及切图任务状态。 |
模型标注
API | 描述 |
---|---|
获取原始标注信息 | 调用GetOriginLayoutData获取原始标注信息。 |
获取最新标注信息 | 调用GetLayoutData获取最新标注信息,标注时使用。 |
垂直矫正 | 调用RectVertical对指定子场景下的图片进行垂直矫正,矫正后会删除该子场景关联关系 |
直角优化 | 调用OptimizeRightAngle将墙交汇处优化为直角 |
更新标注信息 | 调用UpdateLayoutData更新标注信息,标注后可以使用此接口保存标注信息。 |
获取关联信息 | 调用UpdateLayoutData获取关联信息,标注时使用。 |
获取单图的关联信息 | 调用GetSingleConnData根据指定子场景获取与其相关的关联数据。 |
更新关联信息 | 调用UpdateConnData更新关联信息,标注时使用,保存最新的关联数据。 |
相对位置提交 | 调用AddRelativePosition提交相对位置关系。 |
算法处理、重建、发布
API | 描述 |
---|---|
查询任务状态 | 调用GetTaskStatus查询任务状态,可以查询所有类型任务状态。 |
添加马赛克 | 调用AddMosaics针对全景图像特定区域进行马赛克处理。 |
恢复原图 | 调用RecoveryOriginImage可将马赛克处理后的图片恢复。 |
热点交互
API | 描述 |
---|---|
获取系统配置信息 | 调用GetWindowConfig获取系统配置信息,预览及后处理时使用。 |
获取热点标注信息 | 调用GetHotspotTag获取热点标注信息,后处理时使用。 |
查询热点标注配置 | 调用GetHotspotConfig查询热点标注配置,后处理时使用。 |
保存热点标注配置 | 调用SaveHotspotConfig保存热点标注配置,后处理时使用。 |
保存热点标注信息 | 调用SaveHotspotTag保存热点标注信息,后处理时使用。 |
发布热点信息 | 调用PublishHotspot发布热点标注信息,后处理时使用。 |