Skip to main content

Superficies REST y HTTP

Mapa orientado a desarrollo de las rutas HTTP relevantes bajo apps/next/src/app/api/. No es un catálogo OpenAPI: sirve para orientarse y profundizar en el código. Los prefijos son relativos al despliegue (p. ej. https://<host>/api/...).

Convenciones

  • /api/trpc — API interna tipada (Docusaurus: tRPC API).
  • /api/shield/... — REST para integraciones; varios namespaces según consumidor (ver tabla).
  • Autenticación — En general Authorization: Bearer <token>; cada subárbol puede validar scopes distintos (middlewares en src/app/middlewares/).

Tabla por prefijo

PrefijoPropósito típico
/api/shield/v1API estable para integraciones generales (usuarios, pólizas, risk items, reclamos, etc.).
/api/shield/v2Evolución de reclamos u otros recursos donde exista versión nueva.
/api/shield/ia/v1, /api/shield/ia/v2Superficies pensadas para flujos de IA / automatización (mismos dominios que v1 en muchos casos, con rutas paralelas).
/api/shield/integrations/v1, v2Partners de integración (reclamos, usuarios, risk items, órdenes, etc.).
/api/postsales/v1Postventa del titular: OTP → JWT (POSTSALES_JWT_*), me/risk-items, CRUD acotado sobre risk items / beneficiarios / variantes. Ver API Post-sales.
/api/payments/siliceToken y datos para el widget de pago (Silice / Reef).
/api/integrationsEntrada HTTP al orquestador de emisión: dispatch (emisión con service role), retry (reintentos), post-sales (emisión tras cambios con JWT post-sales y post_sales_integration_slug). Detalle del flujo: Orquestador e integraciones.
/api/processPaymentProcesamiento de pagos (órdenes, suscripciones).
/api/workflowsEvaluación de workflows, ejecución de webhooks de comunicación. Ver Workflows, automatización y skills.
/api/executeClientWebhooksEntrega hacia webhooks de clientes.
/api/mails/v1Envíos relacionados con reclamos u otros eventos.
/api/addons/v1Generación de PDF u otros add-ons.
/api/features/gen-pdfGeneración de PDF vía features.
/api/skillsEndpoints auxiliares de skills (gestión / asignación en dashboard). Distinto del workflow de reclamos; ver Workflows, automatización y skills.
/api/auth/callbackCallback de autenticación OAuth / proveedor.
/api/cookies/channelUtilidades de canal vía cookies.
/api/trpc/[trpc]Handler tRPC (batch de procedimientos).

Autenticación por namespace (Shield)

Los archivos authorize siguen una convención clara:

  • /api/shield/v1/auth/authorize
  • /api/shield/ia/v1/auth/authorize
  • /api/shield/integrations/v1/auth/authorize

La validación de permisos y el formato del token dependen del middleware aplicado a cada rama (shieldAuth.middleware.ts y similares).

Recursos frecuentes (ejemplos de path)

Ejemplos reales en el código (no exhaustivos):

  • Risk items: .../risk-items, .../risk-items/[riskItemId], variantes, eventos, cancelación, rescisiones.
  • Reclamos: .../claims, .../claims/[claimId], workflow, assets.
  • Pólizas: .../policies/[policyNumber], versiones, subject-schema.
  • Usuarios: .../users, by-email, OTP, verify-otp.
  • Integraciones: webhooks bajo .../integrations/webhooks/[webhookId].

Para la lista completa, usar búsqueda en el repo: src/app/api/**/route.ts.

Supabase Edge Functions

Lógica desplegada fuera del proceso Next (cron, reportes, etc.) vive en apps/next/supabase/functions/. Complementa estas APIs HTTP pero no comparte el mismo prefijo /api/.

Referencias