Zum Hauptinhalt springen

Fehler und Wiederholungsverhalten

Nicht erfolgreiche Antworten verwenden dieses Envelope:
{
  "error": {
    "code": "SOME_CODE",
    "message": "Human-readable explanation",
    "issues": []
  }
}

Hinweise zum Wiederholen

  • Wiederhole Transportfehler.
  • Wiederhole idempotente Schreibvorgänge mit demselben Idempotency-Key.
  • Lies nach asynchroner Arbeit den dauerhaften Zustand erneut, statt anzunehmen, dass die erste Antwort vollständig ist.

Praktische Regeln

  • Betrachte serverseitige Fehler nur dann als Kandidaten für Wiederholungen, wenn der ursprüngliche Schreibvorgang einen stabilen Idempotency-Key verwendet hat.
  • Behandle neue Export-Download-URLs als temporär und lies sie bei Bedarf erneut aus GET /exports/{exportId}.
  • Wenn eine Mutation bereits läuft oder mit dem aktuellen Zustand kollidiert, prüfe den zurückgegebenen code und wiederhole nur, wenn die Operation weiterhin logisch sicher ist.

Maschinenlesbare Clients

Das ausgelieferte Node.js SDK und die CLI normalisieren Fehler zu strukturierten Objekten mit:
  • code
  • message
  • status
  • retryable
Damit ist es möglich, Automatisierungslogik sicher zu verzweigen, ohne frei formulierte Strings zu parsen.