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 預覽圖下載

錯誤碼

相關主題