Table of Contents

API —— Obtener lista de mapas de Spatial Map

Esta interfaz se utiliza para obtener paginadamente la lista de información de todos los Spatial Map (mapas espaciales) en la galería actual.

1. Información básica de la interfaz

  • Dirección de la interfaz: https://armap-api-<cn1,na1>.easyar.com/maps
  • Método de solicitud: GET
  • 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, AppId y parámetros para generar una firma de verificación.
    • Para el algoritmo detallado de cálculo de la firma, consulta 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 utilizarán los valores predeterminados.

Nombre del parámetro Tipo Requerido Valor predeterminado Descripción
pageNum Entero No 1 Número de página objetivo solicitada.
pageSize Entero No 10 Número máximo de mapas mostrados por página.

4. Estructura de datos de respuesta (ResponseResult)

Cuando la solicitud es exitosa (statusCode es 0), el resultado result contendrá la lista de mapas y sus metadatos de paginación.

Nombre del campo Tipo Descripción
statusCode Entero Código de estado. 0 indica éxito.
msg String Mensaje descriptivo del estado.
timestamp DateTime Marca de tiempo de respuesta del servidor.
result Objeto Objeto Map que contiene el array de datos de mapas y la información estadística de paginación.

5. Códigos de estado

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.
404 Not Found Recurso no encontrado.

Códigos de error de Status Code

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