API - Buscar mapas Spatial Map
Esta interfaz se usa para buscar mapas Spatial Map. Todos los parámetros de búsqueda son opcionales. Cuando se usan varios campos para buscar, el sistema conecta las condiciones con lógica "AND".
1. Información básica de la interfaz
- Dirección de la interfaz:
https://armap-api-<cn1,na1>.easyar.com/map - Método de solicitud:
GET - Formato de respuesta:
*/*(normalmenteapplication/json)
2. Método de autenticación
Esta interfaz admite los dos modos de autenticación siguientes:
- Autenticación basada en Token:
- Header:
Authorization: [token] - Parámetro: debe incluirse
AppId.
- Header:
- Autenticación basada en firma (Signature):
- Use
APIKey,APISecret,AppIdy parámetros 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.
- Use
3. Parámetros de solicitud
3.1 Query parameters
Todos los parámetros de búsqueda son opcionales.
| Nombre del parámetro | Tipo | Obligatorio | Valor predeterminado | Descripción |
|---|---|---|---|---|
| gps | String | No | - | Busca mapas cerca de esta coordenada GPS. |
| range | Number | No | 1.0 | Rango de búsqueda (unidad: km). Debe usarse junto con el parámetro gps. |
| name | String | No | - | Busca por nombre de mapa. |
| tag | String | No | - | Busca por etiqueta de mapa. |
4. Estructura de datos de respuesta (ARMapDTO)
Cuando la solicitud se realiza correctamente (statusCode es 0), el result devuelto contiene un array de objetos de mapa que cumplen las condiciones.
| 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 | 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 asociadas al mapa. |
| tag | String | Etiqueta del mapa. |
| meta | String | Metadata personalizada. |
| created | DateTime | Hora de creación. |
| modified | DateTime | Hora de última modificación. |
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. |
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": "office_scene",
"status": "active",
"gps": "121.4541,31.2221",
"tag": "indoor"
}
]
}