Table of Contents

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

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

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

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

2. Способ аутентификации

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

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

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

3.1 Path parameters

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

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

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

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

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

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

5. Status codes

Http Code Значение Описание
200 OK Запрос выполнен успешно.
401 Unauthorized Аутентификация не выполнена. Проверьте Token или подпись.
403 Forbidden Нет прав доступа к этому ресурсу.
404 Not Found Указанная карта или metadata не найдены.

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

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