Table of Contents

Introduzione alle API di gestione di Sparse Spatial Map

Panoramica delle API

Protocollo REST API e meccanismo di autenticazione

Spatial Map API segue la specifica standard di trasporto HTTP REST.

Intestazione HTTP

    Authorization:

I parametri della richiesta HTTP si dividono in due tipi:

  • Parametri pubblici (sono inclusi tutti questi; vengono usati in modo diverso a seconda del metodo di autenticazione):

    • appId
    • timestamp (intero Long: millisecondi trascorsi dalle 00:00:00 UTC del 1 gennaio 1970)
    • apiKey
    • signature (firma della richiesta, scegliere autenticazione tramite token o autenticazione tramite firma)

  • Parametri di Spatial Map API: i parametri propri dell'API

    La documentazione dell'API non descrive più i parametri pubblici usati per l'autenticazione

Autenticazione API Key

Esistono due metodi di autenticazione.

Autenticazione basata su token

L'intestazione HTTP Authorization contiene il Token, e i parametri pubblici includono:

  • appId

Autenticazione tramite firma

Non usare l'intestazione HTTP Authorization.

I parametri della richiesta contengono le informazioni di firma. Tutti i parametri sono inclusi nel calcolo della firma (tranne l'immagine).

  • appId
  • timestamp
  • apiKey
  • signature

Per l'algoritmo dettagliato del calcolo della firma, fare riferimento al metodo di firma API Key.

Esempi d'uso e interpretazione delle proprietà

Esempio di utilizzo dell'API

L'esempio seguente usa una chiamata API per interrogare i dati Spatial Map e aiutare gli sviluppatori a comprendere l'API Spatial Map e la struttura della mappa spaziale.

Esempio di richiesta

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

Esempio di risposta

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

Proprietà sparse map

Come mostrato nell'esempio sopra, questa è la struttura Spatial Map restituita normalmente

Proprietà Descrizione
mapId ID univoco della mappa
name Nome della mappa
size Dimensione del file della mappa
meta Dati associati all'utente, che possono essere un file, testo o url, e devono essere codificati in base64
status Indica se è disabilitata, i valori sono [active inactive]
tag Etichetta personalizzata per facilitarne la ricerca
floor Piano per facilitarne la ricerca
gps Posizione geografica dello spazio, sistema di coordinate wgs84 o un sistema di coordinate definito dall'utente
previewUrl Download dell'immagine di anteprima

Codici di errore

Argomenti correlati