Table of Contents

Api —— actualización de información de mapa spatial map

Esta interfaz actualiza la información del mapa mediante el mapId especificado. Admite un modo de actualización similar a HTTP PATCH, es decir, solo modifica los parámetros proporcionados en la solicitud, y los parámetros no proporcionados permanecerán sin cambios.

1. Información básica de la interfaz

  • Dirección de la interfaz: 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. Método de autenticación

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

  1. Autenticación basada en token:
    • Header: Authorization: [token]
    • Parámetros: Se debe incluir AppId.
  2. Autenticación basada en firma (signature):
    • Utiliza APIKey, APISecret y AppId junto con los parámetros para generar una firma para la verificación.
    • Para el algoritmo detallado de cálculo de firma, consulta 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 Requerido Descripción
mapId String Identificador único del mapa espacial (MapId).

3.2 Parámetros de formulario (form parameters)

Debido al formato multipart/form-data, los siguientes parámetros deben enviarse a través de campos de formulario.

Nombre del parámetro Tipo Requerido Descripción
file File No Nuevo archivo de datos del mapa.
name String No Nombre para mostrar del mapa.
gps String No Coordenadas GPS asociadas al mapa (ej: "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 clúster.
emeBlocklist String No Configuración de la lista negra EME, predeterminada "[]".

4. Estructura de datos de respuesta (ARMapDTO)

Cuando la solicitud es exitosa (statusCode es 0), el resultado result contendrá los detalles del objeto mapa actualizado.

Nombre del campo Tipo Descripción
statusCode Integer Código de estado. 0 representa éxito.
msg String Mensaje de descripción 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 del mapa (bytes).
gps String Información de coordenadas GPS asociadas al mapa.
tag String Etiqueta del mapa.
meta String Metadatos personalizados.
md5 String Código de verificación MD5 del archivo de mapa actualizado.
modified DateTime Hora de última modificación.

5. Códigos de estado (status codes)

Código Http Significado Explicación
200 OK Solicitud exitosa.
201 Created Actualización exitosa y registros relacionados creados.
401 Unauthorized Autenticación fallida, verifique el token o la firma.
403 Forbidden Sin permiso para acceder a este recurso.
404 Not Found No se encontró el mapId especificado.

Explicación de códigos de error status code

6. Ejemplo de respuesta (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"
  }
}