Table of Contents

Introduzione alle api di gestione delle mappe sparse spaziali

Api summary

Rest api protocollo interfaccia e meccanismo di autenticazione

Le api spatial map seguono lo standard di trasmissione HTTP REST.

Intestazione HTTP

    Authorization:

Parametri richiesta HTTP, di due tipi:

  • Parametri comuni (inclusi questi, combinati in base al metodo di autenticazione):

    • appId
    • timestamp (Long tipo intero lungo: millisecondi trascorsi dal 1 gennaio 1970 00:00:00 UTC)
    • apiKey
    • signature (firma richiesta, alternativa all'autenticazione token)

  • Parametri API Spatial Map: parametri specifici dell'API

    I parametri comuni di autenticazione non sono descritti nella documentazione API

Autenticazione API Key

Due metodi di autenticazione.

Autenticazione basata su token

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

  • appId

Autenticazione firma

Non utilizza l'intestazione HTTP Authorization.

I parametri della richiesta contengono la firma signature. Tutti i parametri sono inclusi nel calcolo della firma (eccetto immagini).

  • appId
  • timestamp
  • apiKey
  • signature

Per l'algoritmo dettagliato del calcolo della firma, consultare Metodo firma API Key.

Esempi di utilizzo e analisi delle proprietà

Esempio di utilizzo API

Un esempio - chiamare l'interfaccia API per interrogare i dati della mappa spaziale, aiuta gli sviluppatori a comprendere l'interfaccia API Spatial Map e la struttura della mappa spaziale.

Esempio 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 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à mappa sparsa

Come mostrato nell'esempio, questa è la struttura della mappa spaziale spatial map restituita

Proprietà Descrizione
mapId ID univoco della mappa
name Nome della mappa
size Dimensione file mappa
meta Dati associati utente, possono essere file, testo o URL, richiede codifica base64
status Stato disabilitazione, due valori [active inactive]
tag Etichetta personalizzata per facilitare la ricerca
floor Piano, per facilitare la ricerca
gps Posizione geografica, sistema di coordinate wgs84 o sistema personalizzato
previewUrl Download immagine anteprima

Codici errore

Argomenti correlati