Table of Contents

API - Obtener la dirección de descarga de los datos meta

Esta interfaz se usa para obtener, mediante mapId, la información del recurso de descarga de metadata (meta) asociada con el Spatial Map especificado.

1. Información básica de la interfaz

  • Dirección de la interfaz: https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • Método de solicitud: GET
  • Formato de respuesta: */* (normalmente application/json)

2. Método de autenticación

Esta interfaz admite los dos modos de autenticación siguientes:

  1. Autenticación basada en Token:
    • Header: Authorization: [token]
    • Parámetro: debe incluirse AppId.
  2. Autenticación basada en firma (Signature):
    • Use APIKey, APISecret y AppId para generar una firma para la verificación.
    • Para el algoritmo detallado de cálculo de firma, consulte método de firma de API Key.

3. Parámetros de solicitud

3.1 Path parameters

Nombre del parámetro Tipo Obligatorio Descripción
mapId String Identificador único del mapa espacial (MapId).

4. Estructura de datos de respuesta (Resource)

Cuando la solicitud se realiza correctamente (statusCode es 0), el result devuelto contiene un objeto Resource que apunta al archivo metadata.

Nombre del campo Tipo Descripción
statusCode Integer Código de estado. 0 indica éxito.
msg String Información de descripción del estado.
timestamp DateTime Marca de tiempo de la respuesta del servidor.
result Object Objeto Map que contiene el array de datos del mapa y estadísticas de paginación.

Estructura del objeto Resource:

Nombre del campo Tipo Descripción
filename String Nombre del archivo metadata.
url Object (URL) Objeto que contiene información detallada de la dirección de descarga, como protocol, host y path.
file Object (File) Información de propiedades físicas del archivo, como path y size.
readable Boolean Si este recurso es legible.
open Boolean Si este recurso está actualmente abierto.

5. Status codes

Http Code Significado Descripción
200 OK Solicitud realizada correctamente.
401 Unauthorized Autenticación fallida. Compruebe el Token o la firma.
403 Forbidden Sin permiso para acceder a este recurso.
404 Not Found No se encontró el mapa o metadata especificados.

Códigos de error de Status Code

6. Respuesta de ejemplo (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
  }
}