Table of Contents

稀疏空间地图管理 APIs 简介

API 大全

REST API 接口协议与鉴权机制

Spatial Map API 遵循标准 HTTP REST 传输标准。

Http Header

    Authorization: <填入 APIKey 中获取的 Token>

Http 请求参数，分为两种类型:

  • 公共参数 (总共包括这些，认证方式不同搭配不同使用)：

    • appId
    • timestamp（Long 长整型: 1970年1月1日00:00:00 UTC 以来经过的毫秒数）
    • apiKey
    • signature（请求签名，token 方式认证二选一）

  • Spatial Map API 参数：API 自己的参数

    API 文档不再描述认证用的公共参数

API Key 认证

认证方式分为两种。

基于 Token 认证

Http 头部 Authorization 包含 Token， 公共参数包括：

  • appId

签名认证

不用 Http 头部 Authorization。

请求参数含有 signature 签名信息。所有参数纳入签名计算(图像除外)。

  • appId
  • timestamp
  • apiKey
  • signature

有关签名计算的详细算法，请参考文档 API Key 签名方法。

使用示例与属性解析

API 使用示例

这里通过一个示例 —— 调用 API 接口查询 Spatial Map 地图数据，帮助开发者了解 Spatial Map API 接口以及空间地图结构。

请求示例

  GET /maps HTTP/1.1
  Host:
  Date: Mon, 1 Jan 2018 00:00:00 GMT
  Content-Type: application/json
  {
      "timestamp": 1769406019000,
      "apiKey": "8b485c648c3056e79c2a85ee9b...",
      "appId": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9..",
      "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
  }

返回示例

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

稀疏地图属性

如上面示例所示，这是正常返回 Spatial Map 空间地图结构体

属性 描述
mapId 地图的唯一 Id
name 地图名称
size 地图文件大小
meta 用户关联数据，可以文件可以文本或者 url，需要 base64 编码
status 是否停用，两个值 [active inactive]
tag 自定义标签，方便检索
floor 楼层，方便检索
gps 空间所在地理位置，wgs84 坐标系，也可使用自己定义坐标系
previewUrl 预览图下载

错误码

相关主题