Table of Contents

API —— Suche Spatial Map Karten

Diese Schnittstelle dient zur Suche nach Spatial Maps (Raumkarten). Alle Suchparameter sind optional. Bei Verwendung mehrerer Felder werden die Bedingungen durch "AND"-Logik verknüpft.

1. Grundlegende Informationen zur Schnittstelle

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

2. Authentifizierungsmethoden

Diese Schnittstelle unterstützt zwei Authentifizierungsmodi:

  1. Token-basierte Authentifizierung:
    • Header: Authorization: [token]
    • Parameter: Erfordert AppId.
  2. Signaturbasierte (Signature) Authentifizierung:
    • Verwendet APIKey, APISecret, AppId und Parameter zur Signaturgenerierung und -prüfung.
    • Detaillierte Signaturalgorithmen finden Sie unter API Key Signaturmethode.

3. Anfrageparameter

3.1 Abfrageparameter (Query Parameters)

Alle Suchparameter sind optional.

Parametername Typ Erforderlich Standardwert Beschreibung
gps String Nein - Sucht Karten in der Nähe dieser GPS-Koordinate.
range Number Nein 1.0 Suchradius (Einheit: km). Muss mit dem Parameter gps verwendet werden.
name String Nein - Sucht nach Kartenname.
tag String Nein - Sucht nach Karten-Tag.

4. Antwortdatenstruktur (ARMapDTO)

Bei erfolgreicher Anfrage (statusCode 0) enthält das Ergebnis result ein Array mit passenden Kartenobjekten.

Feldname Typ Beschreibung
statusCode Integer Statuscode. 0 bedeutet Erfolg.
msg String Statusbeschreibung.
timestamp DateTime Zeitstempel der Serverantwort.
result Array Enthält ein Array von ARMapDTO-Objekten.

ARMapDTO-Objektstruktur

Feldname Typ Beschreibung
mapId String Eindeutige Kartenkennung.
name String Kartenname.
status String Aktueller Kartenstatus.
size Integer (int64) Kartendateigröße.
gps String Zugehörige GPS-Koordinateninformation der Karte.
tag String Karten-Tag.
meta String Benutzerdefinierte Metadaten.
created DateTime Erstellungszeit.
modified DateTime Zeit der letzten Änderung.

5. Statuscodes (Status Codes)

HTTP-Code Bedeutung Erläuterung
200 OK Anfrage erfolgreich.
401 Unauthorized Authentifizierung fehlgeschlagen. Bitte Token oder Signatur prüfen.
403 Forbidden Keine Berechtigung für den Zugriff auf diese Ressource.

Statuscode-Fehlercodes

6. Beispielantwort (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": [
    {
      "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
      "name": "office_scene",
      "status": "active",
      "gps": "121.4541,31.2221",
      "tag": "indoor"
    }
  ]
}