Repetir com segurança usando uma chave de idempotência
Esta receita mostra como repetir com segurança a chamada de início de importação após uma falha de rede ou um erro ambíguo. O cabeçalho Idempotency-Key em POST /api/v1/monitoring/loan/imports faz a segunda chamada retornar o mesmo ID de importação da primeira, com uma URL de upload recém-gerada — nenhuma importação duplicada é criada.
Quando usar
Sempre que você não souber se a chamada anterior de início de importação foi registrada. Os dois casos típicos:
- O seu cliente HTTP gerou um timeout antes de a resposta chegar. A requisição pode ter chegado ao Waafir e iniciado uma importação; você não sabe.
- Você recebeu um erro 5xx de uma superfície não idempotente e quer repetir sem arriscar trabalho duplicado.
A convenção de toda a plataforma é que todo endpoint que altera dados aceita Idempotency-Key — o endpoint de início de importação aqui, o endpoint de exportação, os endpoints de alteração de auditoria em outros lugares. Use uma chave nova por operação lógica; reutilize-a nas novas tentativas da mesma operação. Um padrão comum é um UUID v4 gerado uma vez por intenção de "lote de importação diária" e mantido no estado do seu job até que a chamada tenha sucesso.
O contrato
- O cabeçalho é
Idempotency-Key: <your-string>. Máximo de 255 caracteres. - O corpo também aceita um campo
idempotencyKey; o cabeçalho tem precedência quando ambos estão presentes. Prefira o cabeçalho — é o posicionamento oficial em toda a plataforma. - Uma chamada repetida com o mesmo
(orgId, idempotencyKey)retorna:- o mesmo
importId, reused: truena resposta,- uma URL de upload recém-gerada (a URL original expira; a nova é a que deve ser usada com segurança).
- o mesmo
- Uma chamada repetida com um corpo diferente, mas a mesma chave, é rejeitada; a chave fica vinculada ao formato da requisição original.
A receita
# 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"],
})O que verificar
Em uma primeira chamada bem-sucedida, reused é false. Em qualquer chamada posterior com a mesma chave, reused é true e importId é igual ao da primeira chamada. A uploadUrl é gerada novamente a cada chamada, então repetir depois que uma URL antiga expira é seguro — use sempre a URL da resposta mais recente.
Se você repetir com um corpo de requisição diferente e a mesma chave, a API retorna um erro indicando que a chave está vinculada a um formato de requisição conflitante; troque a chave para a nova intenção.