Table of Contents

Введение в APIs управления Sparse Spatial Map

Обзор API

Протокол REST API и механизм аутентификации

Spatial Map API следует стандартной спецификации HTTP REST.

HTTP Header

    Authorization: <вставьте Token, полученный из APIKey>

Параметры HTTP-запроса делятся на два типа:

  • Общие параметры (все перечисленные; они используются по-разному в зависимости от способа аутентификации):

    • appId
    • timestamp (целое Long: количество миллисекунд, прошедших с 00:00:00 UTC 1 января 1970 года)
    • apiKey
    • signature (подпись запроса, выберите аутентификацию по token или по signature)

  • Параметры Spatial Map API: собственные параметры API

    В документации API больше не описываются общие параметры, используемые для аутентификации

Аутентификация API Key

Существует два способа аутентификации.

Аутентификация на основе Token

HTTP-заголовок Authorization содержит Token, а общие параметры включают:

  • appId

Аутентификация по подписи

Не используйте HTTP-заголовок Authorization.

Параметры запроса содержат информацию о подписи. Все параметры входят в расчет подписи (кроме изображения).

  • appId
  • timestamp
  • apiKey
  • signature

Подробный алгоритм расчета подписи см. в разделе метод подписи API Key.

Примеры использования и описание свойств

Пример использования API

В следующем примере API вызывается для запроса данных Spatial Map, чтобы помочь разработчикам понять API Spatial Map и структуру пространственной карты.

Пример запроса

  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
}

Свойства sparse map

Как показано в примере выше, это обычная возвращаемая структура Spatial Map

Свойство Описание
mapId Уникальный ID карты
name Название карты
size Размер файла карты
meta Данные, связанные с пользователем, могут быть файлом, текстом или url, и должны быть закодированы в base64
status Отключена ли она, значения [active inactive]
tag Пользовательский тег для удобного поиска
floor Этаж для удобного поиска
gps Географическое положение пространства, система координат wgs84 или собственная система координат
previewUrl Скачивание изображения предпросмотра

Коды ошибок

Связанные темы