Table of Contents

Einführung in die Sparse Spatial Map-Verwaltungs-APIs

API-Übersicht

REST-API-Protokoll und Authentifizierungsmechanismus

Spatial Map API folgt der Standard-HTTP-REST-Übertragungsspezifikation.

HTTP-Header

    Authorization: <den aus der APIKey erhaltenen Token einfügen>

HTTP-Anfrageparameter werden in zwei Typen unterteilt:

  • Öffentliche Parameter (alle diese sind enthalten; sie werden je nach Authentifizierungsmethode unterschiedlich verwendet):

    • appId
    • timestamp (Long-Ganzzahl: die seit 00:00:00 UTC am 1. Januar 1970 verstrichenen Millisekunden)
    • apiKey
    • signature (Anfrage-Signatur, Token-Authentifizierung oder Signatur-Authentifizierung wählen)

  • Spatial Map API-Parameter: die eigenen Parameter der API

    In der API-Dokumentation werden die für die Authentifizierung verwendeten öffentlichen Parameter nicht mehr beschrieben

API-Key-Authentifizierung

Es gibt zwei Authentifizierungsmethoden.

Token-basierte Authentifizierung

Im HTTP-Header Authorization ist der Token enthalten, und die öffentlichen Parameter umfassen:

  • appId

Signatur-Authentifizierung

Verwenden Sie nicht den HTTP-Header Authorization.

Die Anfrageparameter enthalten Signaturinformationen. Alle Parameter werden in die Signaturberechnung einbezogen (außer dem Bild).

  • appId
  • timestamp
  • apiKey
  • signature

Für den detaillierten Algorithmus der Signaturberechnung lesen Sie bitte API-Key-Signaturmethode.

Verwendungsbeispiele und Attributinterpretation

API-Verwendungsbeispiel

Das folgende Beispiel verwendet einen API-Aufruf, um Spatial Map-Daten abzufragen, damit Entwickler die Spatial Map API und die Struktur der Spatial Map verstehen können.

Anfragebeispiel

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

Antwortbeispiel

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

Eigenschaften der Sparse Map

Wie im obigen Beispiel zu sehen ist, handelt es sich um die normal zurückgegebene Spatial Map-Struktur

Eigenschaft Beschreibung
mapId Eindeutige Karten-ID
name Kartenname
size Größe der Kartendatei
meta Nutzerdaten, die Datei, Text oder URL sein können und base64-codiert werden müssen
status Ob sie deaktiviert ist, Werte sind [active inactive]
tag Benutzerdefiniertes Tag für einfache Suche
floor Etage für einfache Suche
gps Geografische Lage des Raums, wgs84-Koordinatensystem oder selbst definiertes Koordinatensystem
previewUrl Download des Vorschaubilds

Fehlercodes

Verwandte Themen