API —— búsqueda de mapas espaciales

Esta interfaz se utiliza para buscar Spatial Map (mapas espaciales). Todos los parámetros de búsqueda son opcionales. Cuando se utilizan múltiples campos para la búsqueda, el sistema combinará las condiciones mediante lógica "AND".

1. Información básica de la interfaz

Endpoint: https://armap-api-<cn1,na1>.easyar.com/map
Método: GET
Formato de respuesta: */* (normalmente application/json)

2. Métodos de autenticación

Esta interfaz admite dos modos de autenticación:

Basado en Token:
- Header: Authorization: [token]
- Parámetro: Se debe incluir AppId.
Basado en firma (Signature):
- Utiliza APIKey, APISecret, AppId y parámetros para generar una firma de verificación.
- Para el algoritmo detallado de cálculo de firmas, consulta API Key signature method.

3. Parámetros de solicitud

3.1 Parámetros de consulta (Query Parameters)

Todos los parámetros de búsqueda son opcionales.

Nombre del parámetro	Tipo	Requerido	Valor por defecto	Descripción
gps	String	No	-	Busca mapas cerca de estas coordenadas GPS.
range	Number	No	1.0	Rango de búsqueda (en km). Debe usarse con el parámetro `gps`.
name	String	No	-	Busca por nombre del mapa.
tag	String	No	-	Busca por etiqueta del mapa.

4. Estructura de datos de respuesta (ARMapDTO)

Cuando la solicitud es exitosa (statusCode = 0), el resultado result contendrá un array de objetos de mapa que cumplen los criterios.

Nombre del campo	Tipo	Descripción
statusCode	Integer	Código de estado. 0 indica éxito.
msg	String	Mensaje descriptivo del estado.
timestamp	DateTime	Marca de tiempo de respuesta del servidor.
result	Array	Array que contiene objetos `ARMapDTO`.

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.
gps	String	Información de coordenadas GPS asociada al mapa.
tag	String	Etiqueta del mapa.
meta	String	Metadatos personalizados.
created	DateTime	Fecha de creación.
modified	DateTime	Última fecha de modificación.

5. Códigos de estado (Status Codes)

Código HTTP	Significado	Explicación
200	OK	Solicitud exitosa.
401	Unauthorized	Autenticación fallida. Verifica el Token o la firma.
403	Forbidden	Sin permiso para acceder al recurso.

Códigos de error de Status Code

Explicación de códigos de error de APIs de mapas espaciales dispersos

6. Ejemplo de respuesta (JSON)

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

Table of Contents