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
}