Table of Contents

API —— 獲取 meta 數據的下載地址

此接口用於通過 mapId 獲取指定 Spatial Map(空間地圖)關聯元數據(meta)的下載資源信息。

1. 接口基本信息

  • 接口地址https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • 請求方法GET
  • 響應格式*/* (通常爲 application/json)

2. 認證方式

該接口支持以下兩種鑑權模式:

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

3. 請求參數

3.1 路徑參數 (Path Parameters)

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

4. 響應數據結構 (Resource)

當請求成功(statusCode 爲 0)時,返回結果 result 將包含指向元數據文件的 Resource 對象。

字段名稱 類型 描述
statusCode Integer 狀態碼。0 代表成功。
msg String 狀態描述信息。
timestamp DateTime 服務器響應時間戳。
result Object 包含地圖數據數組及分頁統計信息的 Map 對象。

Resource 對象結構:

字段名稱 類型 描述
filename String 元數據文件的文件名。
url Object (URL) 包含協議、主機、路徑等詳細下載地址信息的對象。
file Object (File) 文件的物理屬性信息(如路徑、大小等)。
readable Boolean 該資源是否可讀。
open Boolean 該資源當前是否處於打開狀態。

5. 狀態碼 (Status Codes)

Http Code 含義 說明
200 OK 請求成功。
401 Unauthorized 認證失敗,請檢查 Token 或簽名。
403 Forbidden 無權訪問該資源。
404 Not Found 未找到指定的地圖或元數據。

Status Code 錯誤碼

6. 示例響應 (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}