API: Spatial Map-Liste abrufen

Diese API wird verwendet, um die Listeninformationen aller Spatial Maps in der aktuellen Bildbibliothek seitenweise abzurufen.

1. Grundlegende API-Informationen

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

2. Authentifizierung

Diese API unterstützt die folgenden zwei Authentifizierungsmodi:

Token-basierte Authentifizierung:
- Header: Authorization: [token]
- Parameter: AppId muss enthalten sein.
Signature-basierte Authentifizierung:
- Verwenden Sie APIKey, APISecret, AppId und Parameter, um eine signature zur Prüfung zu erzeugen.
- Den detaillierten Algorithmus zur Berechnung der signature finden Sie unter API Key-Signaturmethode.

3. Anfrageparameter

3.1 Query-Parameter (Query Parameters)

Paginierungsparameter sind optional. Wenn sie nicht angegeben werden, werden Standardwerte verwendet.

Parametername	Typ	Erforderlich	Standard	Beschreibung
pageNum	Integer	Nein	1	Angeforderte Zielseitennummer.
pageSize	Integer	Nein	10	Maximale Anzahl von Karten pro Seite.

4. Antwortdatenstruktur (ResponseResult)

Bei erfolgreicher Anfrage (statusCode ist 0) enthält das zurückgegebene result die Kartenliste und ihre Paginierungsmetadaten.

Feldname	Typ	Beschreibung
statusCode	Integer	Statuscode. 0 bedeutet Erfolg.
msg	String	Statusbeschreibung.
timestamp	DateTime	Server-Antwortzeitstempel.
result	Object	Map-Objekt mit Kartendatenarray und Paginierungsstatistik.

5. Statuscodes

Http Code	Bedeutung	Hinweise
200	OK	Anfrage erfolgreich.
401	Unauthorized	Authentifizierung fehlgeschlagen. Prüfen Sie Token oder signature.
403	Forbidden	Keine Berechtigung zum Zugriff auf diese Ressource.
404	Not Found	Zugehörige Ressource wurde nicht gefunden.

Status Code-Fehlercodes

Beschreibung der Statuscodes der 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