API —— Obtener URL de descarga de metadatos
Esta interfaz se utiliza para obtener la información de recursos de descarga de metadatos asociados a un Spatial Map (mapa espacial) mediante mapId.
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:
*/*(normalmenteapplication/json)
2. Método de autenticación
Esta interfaz admite dos modos de autenticación:
- Basado en Token:
- Header:
Authorization: [token] - Parámetros: Requiere incluir
AppId.
- Header:
- Basado en firma (Signature):
- Utiliza
APIKey,APISecretyAppIdpara generar una firma de verificación. - Para el algoritmo detallado de cálculo de firma, consulta Método de firma de API Key.
- Utiliza
3. Parámetros de solicitud
3.1 Parámetros de ruta (Path Parameters)
| Nombre del parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| mapId | String | Sí | Identificador único del mapa espacial (MapId). |
4. Estructura de datos de respuesta (Resource)
Cuando la solicitud es exitosa (statusCode es 0), el resultado result contendrá un objeto Resource con la URL del archivo de metadatos.
| 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 | Object | Objeto Map que contiene el array de datos del mapa e información de paginación. |
Estructura del objeto Resource:
| Nombre del campo | Tipo | Descripción |
|---|---|---|
| filename | String | Nombre del archivo de metadatos. |
| url | Object (URL) | Objeto con información detallada de la URL de descarga (protocolo, host, ruta, etc.). |
| file | Object (File) | Información de atributos físicos del archivo (ruta, tamaño, etc.). |
| readable | Boolean | Indica si el recurso es legible. |
| open | Boolean | Indica si el recurso está actualmente abierto. |
5. Códigos de estado (Status Codes)
| Código HTTP | Significado | Explicación |
|---|---|---|
| 200 | OK | Solicitud exitosa. |
| 401 | Unauthorized | Autenticación fallida. Verificar Token o firma. |
| 403 | Forbidden | Sin permisos para acceder al recurso. |
| 404 | Not Found | Mapa o metadatos especificados no encontrados. |
Explicación de códigos de error de Status Code
6. Ejemplo de respuesta (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
}
}