Fehler

Sursa zeigt mit HTTP-Statuscodes, ob eine Anfrage erfolgreich war, und mit einem stabilen Fehlercode, warum nicht. Jede Fehlerantwort hat dieselbe Form:

{
  "detail": "the cursor is malformed or was issued for different filters",
  "error": {
    "code": "api.cursor_invalid",
    "message": "the cursor is malformed or was issued for different filters",
    "details": {"parameter": "cursor"},
    "request_id": "01JB7Q2M4X9V3K8T5N6P0R1S2A",
    "doc_url": "https://developers.sursa.com/errors/api.cursor_invalid"
  }
}

Jeder Code hat eine eigene Seite unter Fehlercodes mit seinem HTTP-Status, den Feldern von details und den Endpunkten, die ihn zurückgeben. Die Seite jedes Endpunkts in der API-Referenz listet die Codes auf, die dieser Endpunkt zurückgeben kann.

HTTP-Status

Validierungsfehler

Bei 422 mit dem Code validation.failed listet detail jedes fehlerhafte Feld mit seiner Position auf:

{
  "detail": [
    {"loc": ["body", "title"], "msg": "String should have at least 1 character", "type": "string_too_short"}
  ],
  "error": {"code": "validation.failed", "message": "request validation failed", "request_id": "01JB7…"}
}

Welche Fehler Sie wiederholen sollten

Wiederholen Sie POST- und PATCH-Anfragen nur mit einem Idempotency-Key, damit eine Wiederholung nach einer verlorenen Antwort kein zweites Objekt erzeugen kann. GET, PUT und DELETE können Sie unverändert wiederholen.

// Retries a request on network errors, 429 and 5xx. The same Idempotency-Key is sent on every attempt.
async function withRetries(send, attempts = 5) {
  for (let attempt = 1; ; attempt++) {
    let response;
    try {
      response = await send();
    } catch (error) {
      if (attempt >= attempts) throw error;
    }
    if (response && response.status !== 429 && response.status < 500) return response;
    if (attempt >= attempts) return response;
    const retryAfter = Number(response?.headers.get("Retry-After"));
    const backoff = Math.min(60, 2 ** (attempt - 1)) * (0.8 + Math.random() * 0.4);
    await new Promise((resolve) => setTimeout(resolve, 1000 * (retryAfter || backoff)));
  }
}

const key = crypto.randomUUID();
const response = await withRetries(() =>
  fetch("https://api.sursa.com/v1/cards/text", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.SURSA_API_KEY}`,
      "Content-Type": "application/json",
      "Idempotency-Key": key,
    },
    body: JSON.stringify({ title: "Refund policy", body_markdown: "Refunds take 14 days." }),
  }),
);

Ein Problem melden

Jede Antwort, ob erfolgreich oder nicht, hat einen Header X-Request-Id, und jeder Fehler hat denselben Wert in error.request_id. Protokollieren Sie ihn zusammen mit Ihrem eigenen Eintrag zur Anfrage. Wenn Sie sich wegen einer Anfrage an den Support wenden, senden Sie ihre Request-ID mit: Die ID führt direkt zum Eintrag dieser Anfrage.

Unbekannte Codes behandeln

Neue Fehlercodes können in jeder Version der API hinzukommen. Behandeln Sie einen unbekannten Code nach seinem HTTP-Status: einen unbekannten 4xx als Anfrage, die in dieser Form nicht gelingen wird, einen unbekannten 5xx als vorübergehendes Problem.