Table of Contents

Einführung in die APIs zur Verwaltung sparser Raumkarten

Api großes vollständiges

Rest api-schnittstellenprotokoll und authentifizierungsmechanismus

Spatial Map API folgt dem standard-HTTP-REST-Übertragungsstandard.

Http-Header

    Authorization: <Token aus APIKey einfügen>

Http-Anfrageparameter sind in zwei Typen unterteilt:

  • Öffentliche Parameter (insgesamt diese, unterschiedliche Authentifizierungsmethoden erfordern unterschiedliche Kombinationen):

    • appId
    • timestamp (Long-Typ: Millisekunden seit 00:00:00 UTC am 1. Januar 1970)
    • apiKey
    • signature (Anfragesignatur, Token-Authentifizierung ist alternativ möglich)

  • Spatial Map-API-Parameter: Eigene Parameter der API

    Authentifizierungsparameter werden in der API-Dokumentation nicht beschrieben

Api key-authentifizierung

Es gibt zwei Authentifizierungsmethoden.

Token-basierte Authentifizierung

Der HTTP-Header Authorization enthält das Token. Öffentliche Parameter umfassen:

  • appId

Signatur-Authentifizierung

Kein HTTP-Header Authorization.

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

  • appId
  • timestamp
  • apiKey
  • signature

Detaillierte Informationen zum Signaturalgorithmus finden Sie im Dokument API Key-Signaturmethode.

Verwendungsbeispiele und eigenschaftsanalyse

Api-verwendungsbeispiel

Hier wird anhand eines Beispiels - dem Aufruf der API-Schnittstelle zum Abfragen von Spatial Map-Daten - gezeigt, wie Entwickler die Spatial Map-API-Schnittstelle und die Raumkartenstruktur 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 sparser karten

Wie im obigen Beispiel gezeigt, ist dies die normale Rückgabe der Spatial Map-Raumkartenstruktur

Eigenschaft Beschreibung
mapId Die eindeutige ID der Karte
name Name der Karte
size Kartendateigröße
meta Benutzerbezogene Daten (können Dateien, Text oder URL sein, Base64-kodiert)
status Deaktivierungsstatus, zwei Werte [active inactive]
tag Benutzerdefinierte Markierung zur einfacheren Suche
floor Etage, zur einfacheren Suche
gps Geografischer Standort des Raums (WGS84-Koordinatensystem oder benutzerdefiniertes System)
previewUrl Vorschaubild-Download

Fehlercodes

Verwandte Themen