API: Obtener la lista de Spatial Map

Esta API se usa para obtener de forma paginada la información de lista de todos los Spatial Map de la biblioteca de imágenes actual.

1. Información básica de la API

Dirección de la API: https://armap-api-<cn1,na1>.easyar.com/maps
Método de solicitud: GET
Formato de respuesta: */* (normalmente application/json)

2. Autenticación

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

Autenticación basada en Token:
- Header: Authorization: [token]
- Parameter: Debe incluirse AppId.
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 consulta (Query Parameters)

Los parámetros de paginación son opcionales. Si no se completan, se usarán valores predeterminados.

Nombre del parámetro	Tipo	Obligatorio	Predeterminado	Descripción
pageNum	Integer	No	1	Número de página objetivo solicitado.
pageSize	Integer	No	10	Número máximo de mapas mostrados por página.

4. Estructura de datos de respuesta (ResponseResult)

Cuando la solicitud se realiza correctamente (statusCode es 0), el result devuelto contiene la lista de mapas y sus metadatos de paginación.

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 Map que contiene el array de datos de mapas y estadísticas de paginación.

5. Códigos de estado

Http Code	Significado	Notas
200	OK	Solicitud correcta.
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 recurso relacionado.

Códigos de error de Status Code

Descripción de códigos de estado de Sparse Spatial Map APIs

6. Respuesta de ejemplo (JSON)

{
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}

Table of Contents