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
  }
}