Table of Contents

API —— Получение списка карт Spatial Map

Данный интерфейс используется для получения списка информации обо всех Spatial Map (пространственных картах) в текущей галерее с разбивкой на страницы.

1. Основная информация об интерфейсе

  • Адрес интерфейса: https://armap-api-<cn1,na1>.easyar.com/maps
  • Метод запроса: GET
  • Формат ответа: */* (обычно application/json)

2. Метод аутентификации

Интерфейс поддерживает следующие два режима аутентификации:

  1. Аутентификация на основе токена:
    • Заголовок (Header): Authorization: [token]
    • Параметр: необходимо передавать AppId.
  2. Аутентификация на основе подписи (Signature):
    • Использует APIKey, APISecret, AppId и параметры для генерации подписи и проверки.
    • Подробный алгоритм расчета подписи см. в Метод подписи API Key.

3. Параметры запроса

3.1 Параметры запроса (Query Parameters)

Параметры пагинации необязательны. Если не указаны, используются значения по умолчанию.

Имя параметра Тип Обязательно По умолчанию Описание
pageNum Integer Нет 1 Целевой номер страницы запроса.
pageSize Integer Нет 10 Максимальное количество карт на странице.

4. Структура данных ответа (ResponseResult)

При успешном запросе (statusCode = 0) результат result будет содержать список карт и метаданные пагинации.

Имя поля Тип Описание
statusCode Integer Код статуса. 0 означает успех.
msg String Описание статуса.
timestamp DateTime Метка времени ответа сервера.
result Object Объект Map, содержащий массив данных карт и статистику пагинации.

5. Коды статуса

HTTP-код Значение Объяснение
200 OK Запрос успешен.
401 Unauthorized Ошибка аутентификации. Проверьте токен или подпись.
403 Forbidden Нет прав доступа к ресурсу.
404 Not Found Ресурс не найден.

Коды ошибок Status Code

6. Пример ответа (JSON)

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