Помилки

Sursa повідомляє кодами статусу HTTP, чи вдався запит, а стабільним кодом помилки — чому він не вдався. Усі відповіді з помилкою мають однакову структуру:

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

Кожен код має власну сторінку в розділі Коди помилок зі статусом HTTP, полями details та операціями, що його повертають. На сторінці кожної операції в довіднику API перелічено коди, які ця операція може повернути.

Статуси HTTP

Помилки валідації

Для 422 з кодом validation.failed поле detail перелічує всі поля, що не пройшли перевірку, кожне з його розташуванням:

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

Які помилки повторювати

Повторюйте запити POST і PATCH лише з Idempotency-Key, щоб повтор після втраченої відповіді не міг створити другий об’єкт. GET, PUT і DELETE можна безпечно повторювати як є.

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

Як повідомити про проблему

Кожна відповідь, успішна чи ні, має заголовок X-Request-Id, а кожна помилка містить те саме значення в error.request_id. Записуйте його у свій журнал разом із записом про запит. Коли звертаєтеся до підтримки щодо запиту, надішліть ID цього запиту: за ним одразу знаходиться запис про цей запит.

Обробка невідомих кодів

Нові коди помилок можуть з’явитися в будь-якій версії API. Обробляйте невідомий код за його статусом HTTP: невідомий 4xx — як запит, що в такому вигляді не вдасться, невідомий 5xx — як тимчасову проблему.