Table of Contents

Введение в API управления разреженными пространственными картами

Полный список API

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

Spatial Map API соответствует стандарту передачи HTTP REST.

Заголовки HTTP

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

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

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

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

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

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

Аутентификация с помощью API Key

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

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

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

  • appId

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

Без заголовка HTTP Authorization.

Параметры запроса содержат подпись signature. Все параметры участвуют в вычислении подписи (кроме изображений).

  • appId
  • timestamp
  • apiKey
  • signature

Подробный алгоритм вычисления подписи см. в документации Метод подписи API Key.

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

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

В этом примере — вызов API для запроса данных пространственной карты — показана структура 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 Уникальный идентификатор карты
name Название карты
size Размер файла карты
meta Пользовательские связанные данные (файл, текст или URL), закодированные в base64
status Статус активности, значения: [active, inactive]
tag Пользовательский тег для удобства поиска
floor Этаж для удобства поиска
gps Географическое местоположение (система координат WGS84 или пользовательская)
previewUrl Ссылка для скачивания превью

Коды ошибок

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