Erros

O Sursa usa os códigos de status HTTP para dizer se uma requisição deu certo e um código de erro estável para dizer por que ela não deu. Toda resposta de erro tem o mesmo formato:

{
  "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 código tem uma página própria em Códigos de erro, com o status HTTP, os campos de details e os endpoints que o retornam. A página de cada endpoint na referência da API lista os códigos que esse endpoint pode retornar.

Status HTTP

Erros de validação

Em um 422 com o código validation.failed, detail lista todos os campos que falharam, cada um com a sua localização:

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

Quais erros merecem nova tentativa

Repita requisições POST e PATCH só com uma Idempotency-Key, para que uma nova tentativa depois de uma resposta perdida não possa criar um segundo objeto. GET, PUT e DELETE podem ser repetidos com segurança como estão.

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

Como relatar um problema

Toda resposta, bem-sucedida ou não, tem um cabeçalho X-Request-Id, e todo erro tem o mesmo valor em error.request_id. Registre-o junto com o seu próprio registro da requisição. Ao entrar em contato com o suporte sobre uma requisição, envie o ID dela: ele leva direto ao registro dessa requisição.

Tratamento de códigos desconhecidos

Novos códigos de erro podem aparecer em qualquer versão da API. Trate um código desconhecido pelo status HTTP: um 4xx desconhecido, como uma requisição que não vai dar certo do jeito que está; um 5xx desconhecido, como um problema temporário.