本產(chǎn)品中所有開放的API，按照功能目錄分類，將API鏈接和API描述羅列出來。
項(xiàng)目管理
| API | 描述 |
|---|---|
| 分頁查詢項(xiàng)目列表 | 調(diào)用ListProject獲取所有項(xiàng)目列表。 |
| 查詢項(xiàng)目信息 | 調(diào)用DetailProject獲取指定項(xiàng)目信息。 |
| 新增項(xiàng)目 | 調(diào)用AddProject創(chuàng)建新項(xiàng)目。 |
| 更新項(xiàng)目名稱 | 調(diào)用UpdateProject更新指定的項(xiàng)目信息 |
| 刪除項(xiàng)目 | 調(diào)用DropProject刪除指定項(xiàng)目 |
主場景管理
| API | 描述 |
|---|---|
| 分頁查看場景列表 | 調(diào)用ListScene獲取指定項(xiàng)目下的所有主場景列表。 |
| 查看場景詳情 | 調(diào)用DetailScene獲取指定主場景信息。 |
| 添加場景 | 調(diào)用AddScene在指定項(xiàng)目下創(chuàng)建特定類型的主場景。 |
| 更新場景名稱 | 調(diào)用UpdateScene更新指定的主場景信息 |
| 刪除場景 | 調(diào)用DropScene刪除指定主場景 |
| 模型重建 | 調(diào)用LabelBuild創(chuàng)建3D模型重建任務(wù) |
| 查詢場景重建任務(wù)狀態(tài) | 調(diào)用GetSceneBuildTaskStatus查詢場景重建任務(wù)狀態(tài) |
| 預(yù)覽 | 調(diào)用TempPreview，在重建完成后可以調(diào)用此預(yù)覽接口獲取預(yù)覽鏈接 |
| 查詢預(yù)覽任務(wù)狀態(tài) | 調(diào)用TempPreviewStatus查詢預(yù)覽任務(wù)狀態(tài)，調(diào)用TempPreview后可以使用此接口查看任務(wù)狀態(tài)，當(dāng)任務(wù)結(jié)束后才可以使用預(yù)覽鏈接進(jìn)行預(yù)覽，需要在調(diào)用TempPreview接口后10分鐘之內(nèi)調(diào)用 |
| 場景發(fā)布 | 調(diào)用PublishScene創(chuàng)建場景發(fā)布任務(wù) |
| 查詢發(fā)布狀態(tài) | 調(diào)用PublishStatus查詢發(fā)布任務(wù)狀態(tài) |
| 場景預(yù)覽數(shù)據(jù) | 調(diào)用GetHotspotSceneData根據(jù)預(yù)覽token查詢場景模型預(yù)覽數(shù)據(jù)及場景模型點(diǎn)位信息 |
子場景管理
| API | 描述 |
|---|---|
| 分頁查看子場景列表 | 調(diào)用ListSubScene獲取指定主場景下的所有子場景列表。 |
| 查看子場景信息 | 調(diào)用DetailSubScene獲取指定子場景信息。 |
| 新增子場景 | 調(diào)用AddSubScene在指定的主場景下添加新的子場景。 |
| 獲取OSS授權(quán) | 調(diào)用GetOssPolicy獲取OSS授權(quán)信息，獲取授權(quán)后使用OSS SDK往指定路徑上傳圖片或視頻文件，上傳完后直接調(diào)用LinkImage接口往子場景中添加圖片。 |
| 關(guān)聯(lián)圖片到子場景 | 調(diào)用LinkImage關(guān)聯(lián)圖片或視頻到子場景，目前一個(gè)子場景只能關(guān)聯(lián)一張圖片或者一個(gè)視頻。 |
| 更新子場景 | 調(diào)用UpdateSubScene更新指定的子場景信息。 |
| 刪除子場景 | 調(diào)用DropSubScene刪除指定的子場景。 |
| 回滾子場景 | 調(diào)用RollbackSubScene將已刪除的子場景進(jìn)行恢復(fù)（僅限全景圖片類型可用）。 |
| 查看子場景下預(yù)處理及切圖任務(wù)狀態(tài) | 調(diào)用GetSubSceneTaskStatus查看子場景下預(yù)處理及切圖任務(wù)狀態(tài)。 |
模型標(biāo)注
| API | 描述 |
|---|---|
| 獲取原始標(biāo)注信息 | 調(diào)用GetOriginLayoutData獲取原始標(biāo)注信息。 |
| 獲取最新標(biāo)注信息 | 調(diào)用GetLayoutData獲取最新標(biāo)注信息，標(biāo)注時(shí)使用。 |
| 垂直矯正 | 調(diào)用RectVertical對指定子場景下的圖片進(jìn)行垂直矯正，矯正后會刪除該子場景關(guān)聯(lián)關(guān)系 |
| 直角優(yōu)化 | 調(diào)用OptimizeRightAngle將墻交匯處優(yōu)化為直角 |
| 更新標(biāo)注信息 | 調(diào)用UpdateLayoutData更新標(biāo)注信息，標(biāo)注后可以使用此接口保存標(biāo)注信息。 |
| 獲取關(guān)聯(lián)信息 | 調(diào)用UpdateLayoutData獲取關(guān)聯(lián)信息，標(biāo)注時(shí)使用。 |
| 獲取單圖的關(guān)聯(lián)信息 | 調(diào)用GetSingleConnData根據(jù)指定子場景獲取與其相關(guān)的關(guān)聯(lián)數(shù)據(jù)。 |
| 更新關(guān)聯(lián)信息 | 調(diào)用UpdateConnData更新關(guān)聯(lián)信息，標(biāo)注時(shí)使用，保存最新的關(guān)聯(lián)數(shù)據(jù)。 |
| 相對位置提交 | 調(diào)用AddRelativePosition提交相對位置關(guān)系。 |
算法處理、重建、發(fā)布
| API | 描述 |
|---|---|
| 查詢?nèi)蝿?wù)狀態(tài) | 調(diào)用GetTaskStatus查詢?nèi)蝿?wù)狀態(tài)，可以查詢所有類型任務(wù)狀態(tài)。 |
| 添加馬賽克 | 調(diào)用AddMosaics針對全景圖像特定區(qū)域進(jìn)行馬賽克處理。 |
| 恢復(fù)原圖 | 調(diào)用RecoveryOriginImage可將馬賽克處理后的圖片恢復(fù)。 |
熱點(diǎn)交互
| API | 描述 |
|---|---|
| 獲取系統(tǒng)配置信息 | 調(diào)用GetWindowConfig獲取系統(tǒng)配置信息，預(yù)覽及后處理時(shí)使用。 |
| 獲取熱點(diǎn)標(biāo)注信息 | 調(diào)用GetHotspotTag獲取熱點(diǎn)標(biāo)注信息，后處理時(shí)使用。 |
| 查詢熱點(diǎn)標(biāo)注配置 | 調(diào)用GetHotspotConfig查詢熱點(diǎn)標(biāo)注配置，后處理時(shí)使用。 |
| 保存熱點(diǎn)標(biāo)注配置 | 調(diào)用SaveHotspotConfig保存熱點(diǎn)標(biāo)注配置，后處理時(shí)使用。 |
| 保存熱點(diǎn)標(biāo)注信息 | 調(diào)用SaveHotspotTag保存熱點(diǎn)標(biāo)注信息，后處理時(shí)使用。 |
| 發(fā)布熱點(diǎn)信息 | 調(diào)用PublishHotspot發(fā)布熱點(diǎn)標(biāo)注信息，后處理時(shí)使用。 |