Table of Contents

API: Actualizar información de Spatial Map

Esta API actualiza la información del mapa mediante el mapId especificado. Admite un método de actualización similar a HTTP PATCH: solo se modifican los parámetros proporcionados en la solicitud, y los no proporcionados permanecen sin cambios.

1. Información básica de la API

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

2. Autenticación

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

  1. Autenticación basada en Token:
    • Header: Authorization: [token]
    • Parameter: Debe incluirse AppId.
  2. Autenticación basada en Signature:
    • Use APIKey, APISecret, AppId y los parámetros para generar una signature de verificación.
    • Para el algoritmo detallado de cálculo de signature, consulte método de firma de API Key.

3. Parámetros de solicitud

3.1 Parámetros de ruta (Path Parameters)

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

3.2 Parámetros de formulario (Form Parameters)

Como se usa multipart/form-data, los siguientes parámetros deben enviarse como campos de formulario.

Nombre del parámetro Tipo Obligatorio Descripción
file File No Nuevo archivo de datos del mapa.
name String No Nombre visible del mapa.
gps String No Coordenadas GPS asociadas al mapa, por ejemplo "121.4541,31.2221".
tag String No Etiqueta del mapa.
meta String No Metadatos personalizados, normalmente una cadena codificada en Base64.
clusterInfo String No Información relacionada con el cluster.
emeBlocklist String No Configuración de blocklist EME. El valor predeterminado es "[]".

4. Estructura de datos de respuesta (ARMapDTO)

Cuando la solicitud se realiza correctamente (statusCode es 0), el result devuelto contiene los detalles del objeto de mapa actualizado.

Nombre del campo Tipo Descripción
statusCode Integer Código de estado. 0 indica éxito.
msg String Información descriptiva del estado.
timestamp DateTime Marca de tiempo de respuesta del servidor.
result Object Objeto ARMapDTO actualizado.

Estructura del objeto ARMapDTO

Nombre del campo Tipo Descripción
mapId String Identificador único del mapa.
name String Nombre del mapa.
status String Estado actual del mapa.
size Integer (int64) Tamaño del archivo de mapa en bytes.
gps String Información de coordenadas GPS asociada al mapa.
tag String Etiqueta del mapa.
meta String Metadatos personalizados.
md5 String Suma de verificación MD5 del archivo de mapa actualizado.
modified DateTime Hora de última modificación.

5. Códigos de estado

Http Code Significado Notas
200 OK Solicitud correcta.
201 Created Actualización correcta y registro relacionado creado.
401 Unauthorized Autenticación fallida. Compruebe el Token o la signature.
403 Forbidden Sin permiso para acceder a este recurso.
404 Not Found No se encontró el mapId especificado.

Códigos de error de Status Code

6. Respuesta de ejemplo (JSON)

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