API HTTP

FrameKit expone un controlador HTTP de Node.js para el acceso opcional a Studio y el renderizado síncrono de PNG. En el proyecto canónico, móntalo desde la ruta catch-all del App Router en /api/framekit/[...action] y mantén esa ruta en el runtime de Node.js. La integración con un proyecto existente muestra la configuración completa de la ruta.

El dispatcher solo expone las rutas documentadas en esta sección. POST /api/framekit/images/render es el endpoint de imágenes en ambos modos. Las demás rutas gestionan la sesión de Studio, la cuenta, los tokens de API y los usuarios solo cuando FRAMEKIT_AUTH_ENABLED=true; en el modo abierto devuelven 404 not_found.

Elige una referencia

API de accesoContrato común y mapa completo de rutas.

API de cuentaInicio y cierre de sesión, cuenta y contraseñas.

API de tokensCreación, listado y revocación de tokens de API.

API de gestión de usuariosGestión administrativa de usuarios y metadatos de sus tokens.

Errores de la API de accesoEstados y códigos de error estables del acceso.

API de renderizado de imágenesEndpoint, autenticación y respuesta PNG.

Entradas de imagenDatos de plantilla y fuentes de imagen compatibles.

Errores de la API de imágenesEstados y códigos de error estables del renderizado de imágenes.

Reglas comunes de respuesta

Las respuestas de acceso son JSON y utilizan Cache-Control: no-store. Los errores de imagen también son JSON y utilizan Cache-Control: no-store; una respuesta de imagen correcta es un PNG con la misma directiva de caché. Los clientes deben basarse en el código documentado de error en lugar de analizar los mensajes legibles para humanos.

La API es síncrona. En el modo autenticado, una solicitud de renderizado se autentica antes de analizar la solicitud. En el modo abierto no se comprueban las credenciales, pero se mantienen las defensas del renderizador. Después, la solicitud resuelve la plantilla y sus datos, inicia el renderizado de Chromium en el servidor y devuelve los bytes del PNG en la misma respuesta.

Límite de seguridad

La cookie de sesión es para el acceso a Studio desde el mismo origen cuando la autenticación está activada. Un token de API Bearer solo se acepta en el endpoint de renderizado de imágenes y solo en el modo autenticado. En el modo abierto el endpoint de imágenes no necesita credenciales. No incluyas un token en una URL, un bundle del navegador, el DOM renderizado ni el código del cliente. Lee Seguridad y proxies inversos antes de exponer públicamente el controlador.