API —— Spatial Map kartenerstellung auflisten abrufen

Diese Schnittstelle dient zum abrufen der liste aller Spatial Maps (räumliche karten) im aktuellen galerieverzeichnis mit seitenaufteilung.

1. Schnittstellen grundinformationen

Schnittstellenadresse: https://armap-api-<cn1,na1>.easyar.com/maps
Anfragemethode: GET
Antwortformat: */* (normalerweise application/json)

2. Authentifizierungsmethode

Diese Schnittstelle unterstützt folgende zwei authentifizierungsmodi:

Token-basierte authentifizierung:
- Header: Authorization: [token]
- Parameter: Muss AppId enthalten.
Signatur-basierte (Signature) authentifizierung:
- Verwendet APIKey, APISecret, AppId und parameter zur signaturgenerierung und validierung.
- Detaillierter algorithmus zur signaturberechnung, siehe API Key signaturmethode.

3. Anfrageparameter

3.1 Abfrageparameter (Query Parameters)

Seitenaufteilungsparameter sind optional. Ohne eingabe werden standardwerte verwendet.

Parametername	Typ	Erforderlich	Standardwert	Beschreibung
pageNum	Integer	Nein	1	Zielseitennummer der anfrage.
pageSize	Integer	Nein	10	Maximale anzahl von karten pro seite.

4. Antwortdatenstruktur (ResponseResult)

Bei erfolgreicher anfrage (statusCode 0) enthält das ergebnis result die kartenliste und ihre seitenaufteilungs-metadaten.

Feldname	Typ	Beschreibung
statusCode	Integer	Statuscode. 0 steht für erfolg.
msg	String	Statusbeschreibungsinformation.
timestamp	DateTime	Zeitstempel der serverantwort.
result	Object	Map-Objekt, das kartendaten-array und seitenaufteilungsstatistiken enthält.

5. Statuscodes

HTTP-Code	Bedeutung	Erklärung
200	OK	Anfrage erfolgreich.
401	Unauthorized	Authentifizierung fehlgeschlagen, bitte token oder signatur prüfen.
403	Forbidden	Kein zugriffsrecht auf diese ressourcen.
404	Not Found	Verknüpfte ressourcen nicht gefunden.

Status Code fehlercodes

Erklärung der fehlercodes für sparse spatial map APIs

6. Beispielantwort (JSON)

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

Table of Contents