API - Spatial Map-Karten suchen
Diese Schnittstelle wird verwendet, um Spatial Map-Karten zu suchen. Alle Suchparameter sind optional. Wenn mehrere Felder für die Suche verwendet werden, verbindet das System die Bedingungen mit "AND"-Logik.
1. Grundlegende Schnittstelleninformationen
- Schnittstellenadresse:
https://armap-api-<cn1,na1>.easyar.com/map - Anforderungsmethode:
GET - Antwortformat:
*/*(normalerweiseapplication/json)
2. Authentifizierungsmethode
Diese Schnittstelle unterstützt die folgenden zwei Authentifizierungsmodi:
- Token-basierte Authentifizierung:
- Header:
Authorization: [token] - Parameter:
AppIdmuss enthalten sein.
- Header:
- Signaturbasierte (Signature) Authentifizierung:
- Verwenden Sie
APIKey,APISecret,AppIdund Parameter, um eine Signatur zur Prüfung zu generieren. - Den detaillierten Algorithmus zur Signaturberechnung finden Sie unter API Key-Signaturmethode.
- Verwenden Sie
3. Anforderungsparameter
3.1 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 | Suchbereich (Einheit: km). Muss zusammen mit dem Parameter gps verwendet werden. |
| name | String | Nein | - | Suche nach Kartenname. |
| tag | String | Nein | - | Suche nach Karten-Tag. |
4. Antwortdatenstruktur (ARMapDTO)
Wenn die Anforderung erfolgreich ist (statusCode ist 0), enthält das zurückgegebene result ein Array von Kartenobjekten, die den Bedingungen entsprechen.
| Feldname | Typ | Beschreibung |
|---|---|---|
| statusCode | Integer | Statuscode. 0 bedeutet Erfolg. |
| msg | String | Statusbeschreibungsinformationen. |
| timestamp | DateTime | Zeitstempel der Serverantwort. |
| result | Array | Array mit ARMapDTO-Objekten. |
ARMapDTO-Objektstruktur
| Feldname | Typ | Beschreibung |
|---|---|---|
| mapId | String | Eindeutige Kartenkennung. |
| name | String | Kartenname. |
| status | String | Aktueller Status der Karte. |
| size | Integer (int64) | Dateigröße der Karte. |
| gps | String | Mit der Karte verknüpfte GPS-Koordinateninformationen. |
| tag | String | Karten-Tag. |
| meta | String | Benutzerdefinierte metadata. |
| created | DateTime | Erstellungszeit. |
| modified | DateTime | Zeitpunkt der letzten Änderung. |
5. Status codes
| Http Code | Bedeutung | Beschreibung |
|---|---|---|
| 200 | OK | Anforderung erfolgreich. |
| 401 | Unauthorized | Authentifizierung fehlgeschlagen. Prüfen Sie Token oder Signatur. |
| 403 | Forbidden | Keine Berechtigung zum Zugriff auf diese Ressource. |
Status Code-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"
}
]
}