API: Получение списка Spatial Map

Этот API используется для постраничного получения списка всех Spatial Map в текущей библиотеке изображений.

1. Основная информация API

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

2. Аутентификация

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

Аутентификация на основе Token:
- Header: Authorization: [token]
- Параметр: Необходимо указать AppId.
Аутентификация на основе Signature:
- Используйте APIKey, APISecret, AppId и параметры для создания signature и проверки.
- Подробный алгоритм вычисления signature см. в методе подписи API Key.

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

3.1 Query Parameters (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 Code	Значение	Описание
200	OK	Запрос успешно выполнен.
401	Unauthorized	Ошибка аутентификации. Проверьте Token или signature.
403	Forbidden	Нет прав доступа к этому ресурсу.
404	Not Found	Связанный ресурс не найден.

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

Описание кодов состояния Sparse Spatial Map APIs

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
}

Table of Contents