API —— 搜索 Spatial Map 地图
此接口用于搜索 Spatial Map(空间地图)。搜索参数均为可选,当使用多个字段进行搜索时,系统将通过 "AND" 逻辑连接各个条件。
1. 接口基本信息
- 接口地址:
https://armap-api-<cn1,na1>.easyar.com/map - 请求方法:
GET - 响应格式:
*/*(通常为application/json)
2. 认证方式
该接口支持以下两种鉴权模式:
- 基于 Token 认证:
- Header:
Authorization: [token] - 参数:需附带
AppId。
- Header:
- 基于签名(Signature)认证:
- 使用
APIKey、APISecret、AppId和参数生成签名进行校验。 - 签名计算的详细算法,参考 API Key 签名方法。
- 使用
3. 请求参数
3.1 查询参数 (Query Parameters)
所有搜索参数均为可选。
| 参数名称 | 类型 | 是否必选 | 默认值 | 描述 |
|---|---|---|---|---|
| gps | String | 否 | - | 搜索该 GPS 坐标附近的地图。 |
| range | Number | 否 | 1.0 | 搜索范围(单位:km)。必须配合 gps 参数使用。 |
| name | String | 否 | - | 根据地图名称搜索。 |
| tag | String | 否 | - | 根据地图标签进行搜索。 |
4. 响应数据结构 (ARMapDTO)
当请求成功(statusCode 为 0)时,返回结果 result 将包含符合条件的地图对象数组。
| 字段名称 | 类型 | 描述 |
|---|---|---|
| statusCode | Integer | 状态码。0 代表成功。 |
| msg | String | 状态描述信息。 |
| timestamp | DateTime | 服务器响应时间戳。 |
| result | Array | 包含 ARMapDTO 对象的数组。 |
ARMapDTO 对象结构
| 字段名称 | 类型 | 描述 |
|---|---|---|
| mapId | String | 地图唯一标识。 |
| name | String | 地图名称。 |
| status | String | 地图当前状态。 |
| size | Integer (int64) | 地图文件大小。 |
| gps | String | 地图关联的 GPS 坐标信息。 |
| tag | String | 地图标签。 |
| meta | String | 自定义元数据。 |
| created | DateTime | 创建时间。 |
| modified | DateTime | 最后修改时间。 |
5. 状态码 (Status Codes)
| Http Code | 含义 | 说明 |
|---|---|---|
| 200 | OK | 请求成功。 |
| 401 | Unauthorized | 认证失败,请检查 Token 或签名。 |
| 403 | Forbidden | 无权访问该资源。 |
Status Code 错误码
6. 示例响应 (JSON)
{
"statusCode": 0,
"msg": "success",
"timestamp": "2026-01-30T10:00:00Z",
"result": [
{
"mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
"name": "office_scene",
"status": "active",
"gps": "121.4541,31.2221",
"tag": "indoor"
}
]
}