Errors

Sursa fa servir els codis d’estat HTTP per indicar si una sol·licitud ha anat bé, i un codi d’error estable per indicar per què no. Totes les respostes d’error tenen la mateixa forma:

{
  "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"
  }
}

Cada codi té la seva pàgina a Codis d’error, amb el seu estat HTTP, els camps de details i els punts finals que el retornen. La pàgina de cada punt final a la referència de l’API enumera els codis que aquest punt final pot retornar.

Estats HTTP

Errors de validació

Per a 422 amb el codi validation.failed, detail enumera tots els camps que han fallat, cadascun amb la seva ubicació:

{
  "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…"}
}

Quins errors cal reintentar

Reintenteu les sol·licituds POST i PATCH només amb una Idempotency-Key, perquè un reintent després d’una resposta perduda no pugui crear un segon objecte. GET, PUT i DELETE es poden reintentar sense risc tal com són.

// 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." }),
  }),
);

Informar d’un problema

Cada resposta, correcta o no, té una capçalera X-Request-Id, i cada error té el mateix valor a error.request_id. Deseu-lo als vostres registres juntament amb la sol·licitud. Quan contacteu amb el servei d’assistència per una sol·licitud, envieu-ne l’ID: porta directament a l’anotació d’aquella sol·licitud.

Codis que no coneixeu

Poden aparèixer codis d’error nous en qualsevol versió de l’API. Tracteu un codi desconegut segons el seu estat HTTP: un 4xx desconegut, com una sol·licitud que no tindrà èxit tal com és; un 5xx desconegut, com un problema temporal.