Table of Contents

Introducción a las APIs de gestión de mapas espaciales dispersos

Api completa

Protocolo de API REST y mecanismo de autenticación

Spatial Map API sigue el estándar de transmisión HTTP REST.

Encabezado Http

    Authorization:

Parámetros de solicitud Http, divididos en dos tipos:

  • Parámetros comunes (incluyen estos, diferentes combinaciones según el método de autenticación):

    • appId
    • timestamp (Long entero largo: milisegundos transcurridos desde el 1 de enero de 1970 00:00:00 UTC)
    • apiKey
    • signature (firma de solicitud, autenticación por token o esto)

  • Parámetros de Spatial Map API: parámetros específicos del API

    La documentación del API no describirá más los parámetros comunes de autenticación

Autenticación con API Key

Hay dos métodos de autenticación.

Autenticación basada en Token

El encabezado Http Authorization contiene el Token, los parámetros comunes incluyen:

  • appId

Autenticación por firma

No se usa el encabezado Http Authorization.

Los parámetros de solicitud contienen la firma (signature). Todos los parámetros se incluyen en el cálculo de la firma (excepto imágenes).

  • appId
  • timestamp
  • apiKey
  • signature

Para el algoritmo detallado del cálculo de firma, consulte el documento Método de firma de API Key.

Ejemplos de uso y análisis de propiedades

Ejemplo de uso del API

Aquí un ejemplo: llamar a la API para consultar datos de mapas Spatial Map, que ayuda a los desarrolladores a comprender la estructura de la interfaz y los mapas espaciales.

Ejemplo de solicitud

  GET /maps HTTP/1.1
  Host:
  Date: Mon, 1 Jan 2018 00:00:00 GMT
  Content-Type: application/json
  {
      "timestamp": 1769406019000,
      "apiKey": "8b485c648c3056e79c2a85ee9b...",
      "appId": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9..",
      "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
  }

Ejemplo de respuesta

 {
  "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
}

Propiedades del mapa disperso

Como se muestra arriba, este es el formato de retorno normal para un mapa espacial Spatial Map

Propiedad Descripción
mapId ID único del mapa
name Nombre del mapa
size Tamaño del archivo del mapa
meta Datos asociados por el usuario, pueden ser archivos, texto o URL, deben estar codificados en base64
status Estado de habilitación, dos valores [active inactive]
tag Etiqueta personalizada para facilitar la búsqueda
floor Planta/nivel, para facilitar la búsqueda
gps Ubicación geográfica del espacio, sistema de coordenadas wgs84, o puede usar su propio sistema
previewUrl Descarga de imagen de vista previa

Códigos de error

Temas relacionados