Klantly Developers

Fehlercodes

Jeder Fehler wird als application/problem+json mit einem festen, englischen Code zurückgegeben. Hier steht für jeden Code, was schiefging und wie Sie es beheben.

Der Aufbau eines Fehlers

Eine Fehlerantwort enthält immer type, title, status und code. Bei Validierungsfehlern steht in errors die Meldung pro Feld. Jede Antwort hat eine request_id: Nennen Sie diese, wenn Sie den Support um Hilfe bitten.

application/problem+json
{
  "type": "https://developers.klantly.com/errors/validation_failed",
  "title": "Die Eingabe ist ungültig.",
  "status": 422,
  "code": "validation_failed",
  "detail": "1 Feld ist ungültig.",
  "errors": {
    "email": [
      "Email muss eine gültige E-Mail-Adresse sein."
    ]
  },
  "request_id": "req_01j7zq3k9x2m4n6p8r0t2v4w6y"
}

Alle Fehlercodes

HTTP-Status Code Bedeutung
400 bad_request Ungültige Anfrage.
401 api_key_expired Dieser API-Schlüssel ist abgelaufen.
401 api_key_revoked Dieser API-Schlüssel wurde widerrufen.
401 invalid_api_key Ungültiger API-Schlüssel.
401 unauthenticated Authentifizierung erforderlich.
403 account_suspended Das Konto dieses Unternehmens ist gesperrt.
403 feature_not_available Diese Funktion ist für dieses Unternehmen nicht verfügbar.
403 forbidden Kein Zugriff.
403 insufficient_scope Dieser API-Schlüssel hat keinen Zugriff auf diese Aktion.
403 ip_not_allowed Diese IP-Adresse darf diesen API-Schlüssel nicht verwenden.
403 limit_reached Das Limit des Abonnements ist erreicht.
403 subscription_inactive Dieses Unternehmen hat kein aktives Abonnement.
404 not_found Nicht gefunden.
405 method_not_allowed Diese Methode ist hier nicht erlaubt.
409 conflict Dies steht im Widerspruch zum aktuellen Zustand.
409 idempotency_in_progress Eine Anfrage mit diesem Idempotency-Key wird noch verarbeitet.
409 invalid_state_transition Diese Aktion ist im aktuellen Status nicht möglich.
412 precondition_failed Der Datensatz wurde inzwischen geändert.
413 payload_too_large Der Body der Anfrage ist zu groß.
415 unsupported_media_type Dieses Format wird nicht unterstützt.
422 idempotency_key_reused Dieser Idempotency-Key wurde bereits für eine andere Anfrage verwendet.
422 unknown_field Die Eingabe enthält ein unbekanntes Feld.
422 validation_failed Die Eingabe ist ungültig.
429 rate_limited Zu viele Anfragen.
500 server_error Bei uns ist etwas schiefgelaufen.
503 api_disabled Die API ist vorübergehend nicht verfügbar.