Table of Contents

API —— 獲取 Spatial Map 地圖列表

此接口用於分頁獲取當前圖庫下所有 Spatial Map（空間地圖）的列表資訊。

1. 接口基本資訊

  • 接口地址：https://armap-api-<cn1,na1>.easyar.com/maps
  • 請求方法：GET
  • 響應格式：*/* (通常為 application/json)

2. 認證方式

該接口支援以下兩種鑒權模式：

  1. 基於 Token 認證：
    • Header：Authorization: [token]
    • 參數：需附帶 AppId。
  2. 基於簽名（Signature）認證：
    • 使用 APIKey、APISecret、AppId 和參數生成簽名進行校驗。
    • 簽名計算的詳細算法，參考API Key 簽名方法。

3. 請求參數

3.1 查詢參數 (Query Parameters)

分頁參數是可選的，若不填寫將使用預設值。

參數名稱 類型 是否必選 預設值 描述
pageNum Integer 否 1 請求的目標頁碼。
pageSize Integer 否 10 每頁顯示的最大地圖數量。

4. 響應資料結構 (ResponseResult)

當請求成功（statusCode 為 0）時，返回結果 result 將包含地圖列表及其分頁元資料。

欄位名稱 類型 描述
statusCode Integer 狀態碼。0 代表成功。
msg String 狀態描述資訊。
timestamp DateTime 伺服器響應時間戳。
result Object 包含地圖資料陣列及分頁統計資訊的 Map 物件。

5. 狀態碼

Http Code 含義 說明
200 OK 請求成功。
401 Unauthorized 認證失敗，請檢查 Token 或簽名。
403 Forbidden 無權訪問該資源。
404 Not Found 未找到相關資源。

Status Code 錯誤碼

6. 範例響應 (JSON)

{
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}