Waafir
Эта страница переведена машинным способом и ожидает проверки человеком. Возможны неточности.

Безопасный повтор с ключом идемпотентности

Этот рецепт показывает, как безопасно повторить вызов запуска импорта после сетевого сбоя или неоднозначной ошибки. Заголовок Idempotency-Key в POST /api/v1/monitoring/loan/imports заставляет второй вызов вернуть тот же ID импорта, что и первый, с только что выпущенным URL загрузки — дублирующий импорт не создаётся.

Когда это использовать

Всегда, когда вы не можете определить, дошёл ли предыдущий вызов запуска импорта. Два канонических случая:

  • Ваш HTTP-клиент сообщил о тайм-ауте до получения ответа. Запрос мог дойти до Waafir и запустить импорт; вы этого не знаете.
  • Вы получили ошибку 5xx от неидемпотентного эндпоинта и хотите повторить запрос без риска дублирования работы.

Общее для платформы соглашение: каждый изменяющий эндпоинт принимает Idempotency-Key — здесь это эндпоинт запуска импорта, а в других местах — эндпоинт экспорта и эндпоинты изменения аудита. Используйте новый ключ для каждой логической операции и повторно используйте его при повторах одной и той же операции. Распространённый подход — UUID v4, генерируемый один раз для намерения «daily-import-batch» и хранящийся в состоянии задания, пока вызов не завершится успешно.

Контракт

  • Заголовок — Idempotency-Key: <your-string>. Максимум 255 символов.
  • Тело запроса также принимает поле idempotencyKey; если указаны оба, приоритет у заголовка. Предпочитайте заголовок — это каноническое для всей платформы место.
  • Повторный вызов с той же парой (orgId, idempotencyKey) возвращает:
    • тот же importId,
    • reused: true в ответе,
    • только что выпущенный URL загрузки (исходный URL истекает; безопасно использовать новый).
  • Повторный вызов с другим телом, но тем же ключом отклоняется; ключ привязан к структуре исходного запроса.

Рецепт

# curl — start an import with an idempotency key, then retry safely
set -euo pipefail

PAT="${WAAFIR_PAT}"
BASE_URL="${WAAFIR_BASE_URL:-https://app.waafir.io}"
NDJSON_FILE="loans-2026-05-22.ndjson"
# Generate a fresh key per logical batch intent; keep it stable across retries.
IDEMPOTENCY_KEY="loan-import-2026-05-22-$(uuidgen)"

start_import() {
  curl -fsS -X POST "${BASE_URL}/api/v1/monitoring/loan/imports" \
    -H "Authorization: Bearer ${PAT}" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: ${IDEMPOTENCY_KEY}" \
    -d "$(cat <<JSON
{
  "kind": "loan",
  "filename": "${NDJSON_FILE}",
  "sizeBytes": $(stat -c%s "${NDJSON_FILE}")
}
JSON
)"
}

# First call. If the network bombs out we have no idea whether the
# request landed — but the same key on the next attempt guarantees no
# duplicate import.
RESULT=$(start_import || true)

if [ -z "${RESULT}" ] || ! echo "${RESULT}" | jq -e .importId > /dev/null; then
  echo "first call ambiguous; retrying with the same idempotency key…"
  RESULT=$(start_import)
fi

echo "${RESULT}" | jq '{importId, reused, uploadUrl}'
# On a retry, reused == true; the importId matches the first call's; the
# uploadUrl is fresh.
// TypeScript — retry start-import safely with an Idempotency-Key
import { randomUUID } from "node:crypto";
import { statSync } from "node:fs";

const PAT = process.env.WAAFIR_PAT!;
const BASE_URL = process.env.WAAFIR_BASE_URL ?? "https://app.waafir.io";
const NDJSON_FILE = "loans-2026-05-22.ndjson";
const idempotencyKey = `loan-import-2026-05-22-${randomUUID()}`;

async function startImport() {
    return fetch(`${BASE_URL}/api/v1/monitoring/loan/imports`, {
        method: "POST",
        headers: {
            Authorization: `Bearer ${PAT}`,
            "Content-Type": "application/json",
            "Idempotency-Key": idempotencyKey,
        },
        body: JSON.stringify({
            kind: "loan",
            filename: NDJSON_FILE,
            sizeBytes: statSync(NDJSON_FILE).size,
        }),
    });
}

// Retry up to 3 times on transient failures; the same key makes this safe.
let lastError: unknown;
let result: { importId: string; reused: boolean; uploadUrl: string } | null = null;
for (let attempt = 1; attempt <= 3; attempt++) {
    try {
        const res = await startImport();
        if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
        result = (await res.json()) as typeof result;
        break;
    } catch (err) {
        lastError = err;
        console.warn(`attempt ${attempt} failed; retrying with same idempotency key`, err);
        await new Promise((r) => setTimeout(r, 1_000 * attempt));
    }
}

if (!result) throw lastError;
console.log({ importId: result.importId, reused: result.reused, uploadUrl: result.uploadUrl });
# python — retry start-import safely with an Idempotency-Key
import os
import uuid
import time
import requests
from pathlib import Path

PAT = os.environ["WAAFIR_PAT"]
BASE_URL = os.environ.get("WAAFIR_BASE_URL", "https://app.waafir.io")
NDJSON_FILE = Path("loans-2026-05-22.ndjson")

idempotency_key = f"loan-import-2026-05-22-{uuid.uuid4()}"

def start_import():
    return requests.post(
        f"{BASE_URL}/api/v1/monitoring/loan/imports",
        headers={
            "Authorization": f"Bearer {PAT}",
            "Content-Type": "application/json",
            "Idempotency-Key": idempotency_key,
        },
        json={
            "kind": "loan",
            "filename": NDJSON_FILE.name,
            "sizeBytes": NDJSON_FILE.stat().st_size,
        },
        timeout=30,
    )

# Retry up to 3 times on transient errors. The same key makes a second
# successful call a guaranteed replay of the first.
last_exc = None
result = None
for attempt in range(1, 4):
    try:
        response = start_import()
        response.raise_for_status()
        result = response.json()
        break
    except requests.RequestException as exc:
        last_exc = exc
        print(f"attempt {attempt} failed; retrying with same idempotency key: {exc}")
        time.sleep(attempt)

if result is None:
    raise RuntimeError("all retries exhausted") from last_exc

print({
    "importId": result["importId"],
    "reused": result["reused"],
    "uploadUrl": result["uploadUrl"],
})

Что проверить

При успешном первом вызове reused равно false. При любом последующем вызове с тем же ключом reused равно true, а importId совпадает с полученным в первом вызове. uploadUrl генерируется заново при каждом вызове, поэтому повтор после истечения устаревшего URL безопасен — всегда используйте URL из самого свежего ответа.

Если вы повторите запрос с другим телом и тем же ключом, API вернёт ошибку, указывающую, что ключ привязан к конфликтующей структуре запроса; для нового намерения смените ключ.