Table of Contents

API —— 更新 Spatial Map 地圖資訊

此介面透過指定的 mapId 更新地圖資訊。支援類似 HTTP PATCH 的更新方式,即僅修改請求中提供的參數,未提供的參數將保持原樣。

1. 介面基本資訊

  • 介面地址https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • 請求方法PUT
  • 請求格式multipart/form-data
  • 回應格式*/* (通常為 application/json)

2. 認證方式

此介面支援以下兩種鑑權模式:

  1. 基於 Token 認證
    • HeaderAuthorization: [token]
    • 參數:需附帶 AppId
  2. 基於簽名(Signature)認證
    • 使用 APIKeyAPISecretAppId 和參數生成簽名進行校驗。
    • 簽名計算的詳細演算法,參考 API Key 簽名方法

3. 請求參數

3.1 路徑參數 (Path Parameters)

參數名稱 類型 是否必選 描述
mapId String 空間地圖的唯一識別碼(MapId)。

3.2 表單參數 (Form Parameters)

由於採用 multipart/form-data 格式,以下參數需透過表單欄位提交。

參數名稱 類型 是否必選 描述
file File 新的地圖資料檔案。
name String 地圖顯示名稱。
gps String 地圖關聯的 GPS 座標(如:"121.4541,31.2221")。
tag String 地圖標籤。
meta String 自訂元資料(通常為 Base64 編碼字串)。
clusterInfo String 叢集相關資訊。
emeBlocklist String EME 黑名單配置,預設為 "[]"。

4. 回應資料結構 (ARMapDTO)

當請求成功(statusCode 為 0)時,返回結果 result 將包含更新後的地圖物件詳情。

欄位名稱 類型 描述
statusCode Integer 狀態碼。0 代表成功。
msg String 狀態描述資訊。
timestamp DateTime 伺服器回應時間戳。
result Object 更新後的 ARMapDTO 物件。

ARMapDTO 物件結構

欄位名稱 類型 描述
mapId String 地圖唯一識別。
name String 地圖名稱。
status String 地圖目前狀態。
size Integer (int64) 地圖檔案大小(位元組)。
gps String 地圖關聯的 GPS 座標資訊。
tag String 地圖標籤。
meta String 自訂元資料。
md5 String 更新後地圖檔案的 MD5 校驗碼。
modified DateTime 最後修改時間。

5. 狀態碼 (Status Codes)

Http Code 含義 說明
200 OK 請求成功。
201 Created 更新成功並已建立相關記錄。
401 Unauthorized 認證失敗,請檢查 Token 或簽名。
403 Forbidden 無權存取該資源。
404 Not Found 未找到指定的 mapId

Status Code 錯誤碼

6. 範例回應 (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
    "name": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}