Table of Contents

Introducción a las APIs de gestión de Sparse Spatial Map

Resumen de la API

Protocolo REST de API y mecanismo de autenticación

Spatial Map API sigue la especificación estándar de transporte HTTP REST.

Encabezado HTTP

    Authorization:

Los parámetros de solicitud HTTP se dividen en dos tipos:

  • Parámetros públicos (se incluyen todos estos; se usan de forma diferente según el método de autenticación):

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

  • Parámetros de Spatial Map API: los parámetros propios de la API

    La documentación de la API ya no describe los parámetros públicos usados para la autenticación

Autenticación de API Key

Hay dos métodos de autenticación.

Autenticación basada en token

La cabecera HTTP Authorization contiene el Token, y los parámetros públicos incluyen:

  • appId

Autenticación por firma

No use la cabecera HTTP Authorization.

Los parámetros de la solicitud contienen información de firma. Todos los parámetros se incluyen en el cálculo de la firma (excepto la imagen).

  • appId
  • timestamp
  • apiKey
  • signature

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

Ejemplos de uso e interpretación de propiedades

Ejemplo de uso de la API

El siguiente ejemplo usa una llamada API para consultar datos de Spatial Map y ayudar a los desarrolladores a comprender la API de Spatial Map y la estructura del mapa espacial.

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 de Sparse Map

Como se muestra en el ejemplo anterior, esta es la estructura Spatial Map devuelta normalmente

Propiedad Descripción
mapId ID único del mapa
name Nombre del mapa
size Tamaño del archivo del mapa
meta Datos asociados al usuario, que pueden ser archivo, texto o url, y deben codificarse en base64
status Si está deshabilitado, los valores son [active inactive]
tag Etiqueta personalizada para facilitar la búsqueda
floor Planta para facilitar la búsqueda
gps Ubicación geográfica del espacio, sistema de coordenadas wgs84 o un sistema de coordenadas definido por el usuario
previewUrl Descarga de la imagen de vista previa

Códigos de error

Temas relacionados