Sparse space map APIs Fehlercode-Beschreibung

Antwortformat

Alle API-Antworten verwenden ein einheitliches JSON-Format. Hier ist ein Beispiel:

{

  "statusCode": 119,

  "msg": "Parameter has errors",

  "date": "2022-06-15T09:56:30.000Z",

  "result":  //result ist nur bei statusCode 0 vorhanden, bei Fehlern ist dieses Feld leer

}

Feld	Typ	Beschreibung
statusCode	integer	Geschäftsstatuscode, 0 = Erfolg, ≠0 = Fehler
msg	string	Nachricht
result	object	Rückgabeinhalt. Nur bei Statuscode 0 wird die Zielgrafikstruktur zurückgegeben, sonst leer
date	string	Serverzeit

Wichtig

Nur wenn statusCode == 0, enthält result Antwortinhalte. In anderen Fällen ist result leer
Bei statusCode != 0 die Fehlernachricht msg beachten

Fehlercode-Klassifizierung

HTTP-Statuscode-Beschreibung

HTTP-Statuscode	Beschreibung
200	Anfrage erfolgreich (kann Geschäftsfehler enthalten)
400	Ungültige Anfrageparameter
401	APIKey-Authentifizierung fehlgeschlagen
403	Unzureichende Berechtigungen oder Ressourcensperre
404	Angeforderter URL-Pfad existiert nicht
500	Interner Serverfehler
502	Anwendungsausnahme, möglicher Datenfehler

Hinweis: Geschäftsfehler werden meist via HTTP 200 zurückgegeben, wobei statusCode den spezifischen Fehlertyp anzeigt.

Geschäftsstatuscode-Übersicht

Status Code	Message
0	Success
101	Hochgeladene Datei ist leer
102	Dateigröße überschreitet Limit
106	Parameter fehlt oder ist leer
110	Server-API-Aufruf fehlgeschlagen
111	Ressource nicht gefunden
401	Authentifizierungs-Token abgelaufen
401	Authentifizierungsparameter fehlt
401	Unbekannte appId oder appKey
401	Konto gesperrt
401	Authentifizierung fehlgeschlagen, ungültige Signatur oder Token

Häufige Fehlerszenarien

Timeout ohne Antwort

• Request Timeout: Netzwerkprobleme, Client-Netzwerkumgebung prüfen

Authentifizierungsbezogene Fehler

• Http 401 Unauthorized: APIKey-Authentifizierung fehlgeschlagen, appId/appKey prüfen
• Statuscode 401: Ungültiger App-Key oder App existiert nicht, Konfiguration prüfen

Parameterfehler

• 400 Bad Request: Ungültiges Anfrageparameter-Format

Ressourcenoperationsfehler

• Statuscode 10x: Angeforderte Ressource existiert nicht oder Parameterfehler

Systemfehler

• Http 50x Internal Server Error: Interner Serverfehler oder Anwendungsausnahme. Test via Website oder Sample empfohlen

Bewährte Methoden

1. Client-Verarbeitung: Geschäftserfolg via statusCode prüfen, nicht nur via HTTP-Statuscode
2. Wiederholungsversuche: Bei 5xx-Fehlern Wiederholung sinnvoll, bei 4xx-Fehlern Parameter prüfen
3. Protokollierung: Vollständige Fehlerantworten zur Problemdiagnose protokollieren
4. Timeout-Behandlung: Angemessene Anfrage-Timeout-Zeiten festlegen