エラー

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ステータス

バリデーションエラー

コードvalidation.failedの422では、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を付けて再試行してください。そうすれば、レスポンスが失われた後の再試行で2つ目のオブジェクトが作成されることはありません。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は一時的な問題として扱います。