Constaia
Integraciones

Koa

Valida documentos en Koa con @koa/multer y el SDK de Constaia, traduce los errores a HTTP y verifica el webhook leyendo el cuerpo crudo.

Vas a montar un servidor Koa con @koa/router:

  • POST /api/verify-dni: recibe el fichero con @koa/multer (en memoria), lo analiza con Constaia y devuelve el veredicto.
  • POST /webhooks/constaia: lee el cuerpo crudo con raw-body, verifica la firma y descarta duplicados.

La clave vive solo en el servidor. El navegador o el widget envían el fichero a tu ruta.

Instalación

npm i koa @koa/router @koa/multer multer raw-body @constaia/sdk
npm i -D typescript tsx @types/koa @types/koa__router @types/koa__multer

Funciona con Koa 2 y Koa 3 sobre Node.js 20 o superior.

Variables de entorno

.env
CONSTAIA_API_KEY=ck_test_...
CONSTAIA_WEBHOOK_SECRET=whsec_...

Crea la clave en el panel → API keys. El secreto del webhook se muestra una sola vez al crear el endpoint (Webhooks).

Cliente y utilidades compartidas

src/constaia.ts
import {
  AuthenticationError,
  Constaia,
  ConstaiaError,
  InsufficientCreditsError,
  InvalidRequestError,
  PermissionError,
  RateLimitError,
  type Analysis,
  type WebhookEvent,
} from "@constaia/sdk";

// Lee CONSTAIA_API_KEY del entorno.
export const constaia = new Constaia();

// Lo que devuelves al navegador (y lo que pinta el widget): sin los campos extraídos.
export function publicResult(analysis: Analysis) {
  const { id, object, status, document, verdict, warnings } = analysis;
  return { id, object, status, document, verdict, warnings };
}

export type HttpError = {
  status: number;
  body: { error: { code: string; message: string } };
  retryAfter?: number;
};

const httpError = (status: number, code: string, message: string, retryAfter?: number): HttpError => ({
  status,
  body: { error: { code, message } },
  retryAfter,
});

export function toHttpError(error: unknown): HttpError {
  if (error instanceof InvalidRequestError) {
    // Fichero ilegible, formato no admitido, demasiadas páginas…: el usuario puede corregirlo.
    return httpError(error.status === 413 ? 413 : 422, error.code ?? "invalid_request", error.message);
  }
  if (error instanceof RateLimitError) {
    const wait = Math.ceil(error.retryAfter ?? 1);
    return httpError(429, "rate_limited", "Demasiadas peticiones. Inténtalo en unos segundos.", wait);
  }
  if (error instanceof InsufficientCreditsError) {
    console.error("[constaia] Sin créditos. Recarga en https://app.constaia.com", error.requestId);
    return httpError(503, "unavailable", "La validación no está disponible ahora mismo.");
  }
  if (error instanceof AuthenticationError || error instanceof PermissionError) {
    console.error("[constaia] Revisa CONSTAIA_API_KEY", error.code, error.requestId);
    return httpError(500, "misconfigured", "Error de configuración del servidor.");
  }
  if (error instanceof ConstaiaError) {
    // APIError (5xx), APIConnectionError, APITimeoutError
    console.error("[constaia]", error.name, error.code, error.requestId);
    return httpError(502, "upstream_error", "No se ha podido analizar el documento. Inténtalo de nuevo.");
  }
  console.error(error);
  return httpError(500, "internal_error", "Error interno.");
}

// Deduplicación por webhook-id. En producción, una tabla con clave única.
const processed = new Set<string>();
export const alreadyProcessed = (webhookId: string) => processed.has(webhookId);
export const markProcessed = (webhookId: string) => void processed.add(webhookId);

export async function handleEvent(event: WebhookEvent) {
  switch (event.type) {
    case "analysis.completed":
      // event.data es el análisis completo (con fields). Guárdalo por event.data.id.
      console.log("analysis.completed", event.data.id, event.data.verdict?.status);
      break;
    case "analysis.review_required":
      console.log("A revisión manual", event.data.id);
      break;
    case "analysis.failed":
      console.warn("analysis.failed", event.data.id, event.data.error?.code);
      break;
    case "credits.low":
      console.warn("Quedan pocos créditos: recarga en https://app.constaia.com");
      break;
  }
}

Servidor

src/server.ts
import Koa from "koa";
import Router from "@koa/router";
import multer from "@koa/multer";
import getRawBody from "raw-body";
import { WebhookVerificationError } from "@constaia/sdk";
import {
  alreadyProcessed,
  constaia,
  handleEvent,
  markProcessed,
  publicResult,
  toHttpError,
} from "./constaia.js";

const app = new Koa();
const router = new Router();
const upload = multer({
  storage: multer.memoryStorage(),
  limits: { fileSize: 20 * 1024 * 1024, files: 1 },
});

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (error) {
    if ((error as { code?: string }).code === "LIMIT_FILE_SIZE") {
      ctx.status = 413;
      ctx.body = { error: { code: "file_too_large", message: "Máximo 20 MB." } };
      return;
    }
    throw error;
  }
});

// Aquí va tu autenticación: solo usuarios con sesión deberían gastar créditos.
router.post("/api/verify-dni", upload.single("file"), async (ctx) => {
  const file = ctx.file;
  if (!file) {
    ctx.status = 400;
    ctx.body = { error: { code: "missing_file", message: "Falta el fichero." } };
    return;
  }
  // Mejor aún: el nombre del usuario autenticado, no el del formulario.
  const fields = (ctx.request.body ?? {}) as Record<string, unknown>;
  const fullName = String(fields.full_name ?? "").trim();

  try {
    const analysis = await constaia.analyze(file.buffer, {
      filename: file.originalname,
      expect: "es_dni",
      checks: { notExpired: true, ...(fullName ? { holder: { fullName } } : {}) },
      storage: "none",
      language: "es",
    });
    // Guarda analysis.id y analysis.verdict en tu base de datos.
    ctx.status = analysis.status === "completed" ? 200 : 202;
    ctx.body = publicResult(analysis);
  } catch (error) {
    const { status, body, retryAfter } = toHttpError(error);
    if (retryAfter) ctx.set("Retry-After", String(retryAfter));
    ctx.status = status;
    ctx.body = body;
  }
});

router.post("/webhooks/constaia", async (ctx) => {
  const rawBody = await getRawBody(ctx.req, { limit: "1mb", encoding: "utf8" });

  let event;
  try {
    event = await constaia.webhooks.verify(rawBody, ctx.headers, process.env.CONSTAIA_WEBHOOK_SECRET!);
  } catch (error) {
    if (!(error instanceof WebhookVerificationError)) throw error;
    ctx.status = 400;
    ctx.body = "Invalid signature";
    return;
  }

  const webhookId = ctx.get("webhook-id");
  if (!alreadyProcessed(webhookId)) {
    await handleEvent(event);
    markProcessed(webhookId);
  }
  ctx.status = 204;
});

app.use(router.routes()).use(router.allowedMethods());

const server = app.listen(Number(process.env.PORT ?? 3000));
server.requestTimeout = 120_000;
npx tsx --env-file=.env src/server.ts

Puntos clave:

  • Sin body parser global delante del webhook. raw-body lee el stream de ctx.req; si @koa/bodyparser o koa-body lo han consumido antes, no queda nada que leer. Si los usas, móntalos solo en las rutas que los necesiten.
  • El servidor decide expect y checks, nunca el cliente.
  • filename con el nombre original: al pasar un Buffer, es lo que en modo test decide la respuesta.
  • 202 si el análisis sigue en queued o processing tras 30 s; el resultado llega por webhook.
  • koa-body: si ya lo usas con multipart: true, el fichero llega en ctx.request.files guardado en disco. Pásalo al SDK con fromPath(file.filepath, file.originalFilename) de @constaia/sdk/node.

Qué recibe el navegador

{
  "id": "an_01J…",
  "object": "analysis",
  "status": "completed",
  "document": { "type": "es_dni", "label": "DNI (España)", "confidence": 0.97, "side": "both", "country": "ESP" },
  "verdict": {
    "expected": ["es_dni"],
    "match": true,
    "status": "valid",
    "reasons": [
      { "code": "type_match", "severity": "info", "message": "El documento es DNI (España)." },
      { "code": "not_expired", "severity": "info", "message": "Vigente hasta el 12/03/2031." },
      { "code": "holder", "severity": "info", "message": "Los datos del titular coinciden (full_name)." }
    ]
  },
  "warnings": []
}

Es el formato que pinta el widget con endpoint="/api/verify-dni".

Errores

Error del SDKCuándoQué devuelve tu ruta
InvalidRequestErrorFichero vacío, ilegible, formato no admitido, más de 20 MB, demasiadas páginas u opciones mal formadas (400/409/413/415/422)422 (o 413) con el mensaje, para que el usuario suba otro fichero
RateLimitErrorSuperas las peticiones por segundo de tu clave (429). El SDK ya reintenta dos veces respetando Retry-After429 con Retry-After
InsufficientCreditsErrorNo quedan créditos (402)503 al usuario y una alerta para ti: recarga en el panel
AuthenticationError, PermissionErrorClave ausente, revocada o incorrecta (401/403)500: es un fallo de configuración tuyo, no del usuario
APIError, APIConnectionError, APITimeoutErrorError 5xx de Constaia o de red, tras agotar los reintentos502 y un mensaje de reintentar

Todas extienden ConstaiaError y exponen status, code y requestId. Registra siempre el requestId: es lo que te pedirá soporte. Detalle de cada código en Errores.

Probar en modo test

curl -F "file=@dni_valid.jpg" -F "full_name=María García López" http://localhost:3000/api/verify-dni
Ficherofull_nameResultado
dni_valid.jpgMaría García Lópezvalid
dni_valid.jpgJuan Pérezinvalid: motivo holder con severidad error
dni_expired.jpg(vacío)invalid: not_expired con el mensaje "Caducado el 15/06/2020."
blurry.jpg(vacío)review: motivo low_quality y warnings: ["blurry", "low_quality"]
factura.jpg(vacío)invalid: type_mismatch, no es un DNI

En modo test la respuesta depende del nombre del fichero, que debe ser un JPEG, PNG, WEBP, HEIC o PDF real (vale cualquier imagen renombrada). No gasta créditos y livemode es false. Todos los nombres en Modo test.

Para el webhook, firma un cuerpo con signWebhook y envíalo a la ruta:

scripts/send-test-webhook.ts
import { signWebhook } from "@constaia/sdk";

const body = JSON.stringify({
  type: "analysis.completed",
  created_at: new Date().toISOString(),
  data: { id: "an_test", object: "analysis", status: "completed", verdict: { status: "valid", reasons: [] } },
});
const headers = await signWebhook(body, process.env.CONSTAIA_WEBHOOK_SECRET!);

const res = await fetch("http://localhost:3000/webhooks/constaia", {
  method: "POST",
  headers: { ...headers, "content-type": "application/json" },
  body,
});
console.log(res.status); // 204

Checklist de producción

  • Autenticación y rate limit por usuario en /api/verify-dni: cada llamada gasta créditos.
  • Límite de 20 MB en multer y algo más (21 MB) en el proxy.
  • Timeouts de 60 s o más en proxy y servidor; un análisis síncrono puede tardar hasta 30 s.
  • PDF de más de 30 páginas o volumen alto: async: true + webhook, o lotes.
  • Deduplicación del webhook persistente (restricción única sobre webhook-id).
  • Clave ck_live_ solo en el entorno del servidor.
  • Alerta ante InsufficientCreditsError y el evento credits.low.

Siguientes pasos

En esta página