Fehler
Behandle die Problemantworten und ordne Anfragen zu.
Fehler folgen dem JSON-Problemformat nach RFC 9457 mit dem Medientyp application/problem+json.
{
"type": "https://www.ninjabuy.com/api/v1/problems/bad-body",
"title": "Invalid request",
"status": 400,
"detail": "The request did not match the expected shape.",
"request_id": "REQUEST_ID",
"errors": [{"pointer": "/links", "detail": "Validation detail"}]
}type ist die stabile Problemkennung; title und detail beschreiben das Problem. status entspricht dem HTTP-Status. Optionale errors-Einträge enthalten einen JSON Pointer und Validierungsdetails; ein leerer Pointer bezeichnet den gesamten Körper. Gib request_id (auch in X-Request-Id) an, wenn du ein Problem meldest.
Alle folgenden Typen beginnen mit https://www.ninjabuy.com/api/v1/problems/.
| Typ-Endung | HTTP | Bedeutung / Maßnahme |
|---|---|---|
bad-json | 400 | Der Körper ist kein gültiges JSON. Korrigiere die Syntax. |
bad-body | 400 | Körper, Abfrageparameter oder Cursor bestehen die Validierung nicht. Lies errors. |
bad-idempotency-key | 400 | Verwende 1 bis 255 druckbare ASCII-Zeichen für Idempotency-Key. |
unauthorized | 401 | Sende ein gültiges Bearer-Token; WWW-Authenticate liefert die Metadaten. |
not-found | 404 | Ressource nicht verfügbar, unbekannt oder nicht im Besitz dieses Kontos. |
method-not-allowed | 405 | Verwende die Methode aus Allow. |
idempotency-key-in-progress | 409 | Die erste Anfrage mit diesem Schlüssel läuft. Warte gemäß Retry-After. |
upload-too-large | 413 | Hochgeladene Bytes überschreiten die angegebene Größe oder 20 MiB. |
unsupported-media-type | 415 | Sende Content-Type: application/json. |
idempotency-key-reused | 422 | Dieser Schlüssel wurde mit einer anderen Anfrage verwendet. Verwende einen neuen Schlüssel. |
invalid-workbook | 422 | Der Upload ist keine lesbare XLSX-/CSV-Datei innerhalb der Grenzen. Lies errors. |
upload-expired | 422 | Die Uploadreservierung ist abgelaufen. Lade die Datei erneut hoch. |
rate-limited | 429 | Warte vor einem erneuten Versuch die Sekunden aus Retry-After. |
search-rate-limited | 429 | Das Stichwortsuchkontingent ist ausgeschöpft. Warte gemäß Retry-After. |
service-unavailable | 503 | Versuche es bald erneut; beachte Retry-After, falls vorhanden. |
internal-error | 500 | Versuche es später erneut; bewahre die Anfrage-ID auf, falls das Problem anhält. |
Eine erfolgreiche Anfrage kann trotzdem Fehler einzelner Eingaben enthalten. Behandle Link-Statuswerte getrennt von HTTP-Fehlern. Verwende Idempotency-Key, um eine Erstellungsantwort erneut abzurufen; ohne Schlüssel erstellt eine erneut gesendete Stapelanfrage einen weiteren Auftrag.