API - Поиск карт Spatial Map
Этот интерфейс используется для поиска карт Spatial Map. Все параметры поиска являются необязательными. При использовании нескольких полей для поиска система соединяет условия логикой "AND".
1. Основная информация об интерфейсе
- Адрес интерфейса:
https://armap-api-<cn1,na1>.easyar.com/map - Метод запроса:
GET - Формат ответа:
*/*(обычноapplication/json)
2. Способ аутентификации
Этот интерфейс поддерживает два следующих режима аутентификации:
- Аутентификация на основе Token:
- Header:
Authorization: [token] - Параметр: необходимо включить
AppId.
- Header:
- Аутентификация на основе подписи (Signature):
- Используйте
APIKey,APISecret,AppIdи параметры, чтобы создать подпись для проверки. - Подробный алгоритм вычисления подписи см. в методе подписи API Key.
- Используйте
3. Параметры запроса
3.1 Query parameters
Все параметры поиска являются необязательными.
| Имя параметра | Тип | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|---|
| gps | String | Нет | - | Поиск карт рядом с этой GPS-координатой. |
| range | Number | Нет | 1.0 | Диапазон поиска (единица: km). Должен использоваться вместе с параметром 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 | Пользовательские metadata. |
| created | DateTime | Время создания. |
| modified | DateTime | Время последнего изменения. |
5. Status codes
| Http Code | Значение | Описание |
|---|---|---|
| 200 | OK | Запрос выполнен успешно. |
| 401 | Unauthorized | Аутентификация не выполнена. Проверьте Token или подпись. |
| 403 | Forbidden | Нет прав доступа к этому ресурсу. |
Коды ошибок Status Code
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"
}
]
}