API —— Получение адреса загрузки meta-данных

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

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

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

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

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

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

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

3.1 Параметры пути (Path Parameters)

Имя параметра	Тип	Обязательно	Описание
mapId	String	Да	Уникальный идентификатор пространственной карты (MapId).

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

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

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

Структура объекта Resource:

Имя поля	Тип	Описание
filename	String	Имя файла метаданных.
url	Object (URL)	Объект, содержащий подробную информацию об адресе загрузки (протокол, хост, путь и т.д.).
file	Object (File)	Физическая информация о файле (например, путь, размер).
readable	Boolean	Доступен ли ресурс для чтения.
open	Boolean	Открыт ли ресурс в данный момент.

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

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

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

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

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

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}

Table of Contents