Table of Contents

API —— Abrufen der Download-Adresse für Meta-Daten

Diese Schnittstelle dient dazu, über mapId die Download-Ressourceninformationen der mit einer Spatial Map (Raumkarte) verknüpften Metadaten (meta) abzurufen.

1. Schnittstellen-Grundinformationen

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

2. Authentifizierungsmethode

Diese Schnittstelle unterstützt zwei Authentifizierungsmodi:

  1. Token-basierte Authentifizierung:
    • Header: Authorization: [token]
    • Parameter: Erfordert AppId.
  2. Signatur-basierte Authentifizierung:
    • Verwendet APIKey, APISecret und AppId zur Signaturgenerierung und -validierung.
    • Detaillierte Signaturalgorithmen finden Sie unter API Key Signaturmethode.

3. Anfrageparameter

3.1 Pfadparameter (Path Parameters)

Parameter Typ Erforderlich Beschreibung
mapId String Ja Eindeutiger Identifikator der Spatial Map (MapId).

4. Antwort-Datenstruktur (Resource)

Bei erfolgreicher Anfrage (statusCode 0) enthält das Ergebnis result ein Resource-Objekt mit Verweis auf die Metadaten-Datei.

Feld Typ Beschreibung
statusCode Integer Statuscode. 0 bedeutet Erfolg.
msg String Statusbeschreibung.
timestamp DateTime Zeitstempel der Serverantwort.
result Object Enthält ein Map-Objekt mit Karten-Datenarray und Paginierungsstatistiken.

Resource-Objektstruktur:

Feld Typ Beschreibung
filename String Dateiname der Metadaten-Datei.
url Object (URL) Objekt mit detaillierten Download-Adressinformationen (Protokoll, Host, Pfad etc.).
file Object (File) Physische Dateieigenschaften (Pfad, Größe etc.).
readable Boolean Ob die Ressource lesbar ist.
open Boolean Ob die Ressource aktuell geöffnet ist.

5. Statuscodes (Status Codes)

HTTP-Code Bedeutung Beschreibung
200 OK Anfrage erfolgreich.
401 Unauthorized Authentifizierung fehlgeschlagen. Token oder Signatur prüfen.
403 Forbidden Kein Zugriffsrecht auf die Ressource.
404 Not Found Angegebene Karte oder Metadaten nicht gefunden.

Statuscode-Fehlercodes

6. Beispielantwort (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}