Skip to main content

API Reference

Bienvenido al mapa de APIs de InsureHero. Aquí tienes tres familias distintas; cada una tiene su propia forma de autenticación y de leer la documentación.

Cómo elegir por qué estás integrando​

Si desarrollas…Empieza por…
Pantallas del dashboard (React)tRPC API — sesión Supabase, tipos automáticos.
Integraciones de punta a punta (índice unificado)Integraciones — menú dedicado en la barra superior.
Un partner o sistema que llama por HTTP con API key / JWTShield (API nativa) — secuencia authorize → Bearer.
El portal del titular (postventa, OTP)API Post-sales — JWT POSTSALES_*.
Jobs, dispatch de emisión, webhooks internosSuperficies REST + Orquestador e integraciones.

Secuencia global (mental model)​

Diagrama: Dashboard tRPC, Shield y Post-sales apuntan al núcleo Supabase

Fuente: diagrams/api-reference-modelo-global.mmd — yarn diagrams:build. Clic en el diagrama para ampliarlo.

Tipos de API​

1. tRPC (interna)​

  • Quién: aplicación web autenticada con usuario Supabase.
  • Cómo: trpc.<router>.<procedimiento> desde React; ver tRPC API.
  • Endpoint HTTP: POST /api/trpc.

2. Shield (REST externa)​

  • Quién: integraciones B2B, scripts, otros backends.
  • Cómo: primero token (según rama v1 / ia / integrations), luego Authorization: Bearer; ver Shield (API nativa).
  • Base: /api/shield.
  • Menú lateral: en API Reference verás Shield, Superficies REST y Post-sales en el mismo panel (documentación nativa).

3. Post-sales​

  • Quién: portal del asegurado (titular).
  • Cómo: OTP → JWT dedicado → rutas bajo /api/postsales/v1; ver API Post-sales.

4. Otras superficies​

Integraciones de emisión (/api/integrations/...), pagos, workflows: Superficies REST.

Autenticación (resumen)​

  • tRPC: cookie de sesión Supabase (el usuario ya inició sesión en el dashboard).
  • Shield v1: x-api-key en authorize → JWT para el resto de llamadas.
  • Post-sales: JWT propio en Authorization tras verificar OTP.

Versiones Shield​

Existen ramas v1, v2, ia e integrations con contratos paralelos. Detalle en Shield (API nativa).

Respuestas​

Los handlers usan utilidades comunes (ShieldResponse, etc.); el formato exacto depende del endpoint. En errores, revisa código HTTP + cuerpo JSON con details o mensaje de validación.

Rate limiting​

Si está habilitado en despliegue, puede aparecer información en cabeceras X-RateLimit-*.

Siguiente lectura​

  1. tRPC API — diagrama de secuencia y ejemplos con integrationEmissions.
  2. Shield (API nativa) — curl de ejemplo para authorize y risk-items.
  3. Orquestador e integraciones — flujo dispatch → adaptadores.