API —— поиск карт Spatial Map

Этот интерфейс используется для поиска Spatial Map (пространственных карт). Все параметры поиска являются необязательными. При использовании нескольких условий поиска система объединяет их логикой "И".

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

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

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

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

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

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

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

Все параметры поиска необязательны.

Имя параметра	Тип	Обязательный	Значение по умолчанию	Описание
gps	String	Нет	-	Поиск карт вблизи этой GPS-координаты.
range	Number	Нет	1.0	Радиус поиска (в км). Требуется параметр `gps`.
name	String	Нет	-	Поиск по названию карты.
tag	String	Нет	-	Поиск по тегу карты.

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

При успешном запросе (statusCode = 0) результат result содержит массив объектов карт, соответствующих условиям.

Имя поля	Тип	Описание
statusCode	Integer	Код состояния. 0 означает успех.
msg	String	Описание состояния.
timestamp	DateTime	Метка времени ответа сервера.
result	Array	Массив объектов `ARMapDTO`.

Структура объекта ARMapDTO

Имя поля	Тип	Описание
mapId	String	Уникальный идентификатор карты.
name	String	Название карты.
status	String	Текущее состояние карты.
size	Integer (int64)	Размер файла карты.
gps	String	Связанная GPS-координата карты.
tag	String	Тег карты.
meta	String	Пользовательские метаданные.
created	DateTime	Время создания.
modified	DateTime	Время последнего изменения.

5. Коды состояния (Status Codes)

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

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

Описание кодов ошибок APIs для разреженных пространственных карт

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

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": [
    {
      "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
      "name": "office_scene",
      "status": "active",
      "gps": "121.4541,31.2221",
      "tag": "indoor"
    }
  ]
}

Table of Contents