Referencia de API
La referencia de la barra lateral se genera desde una copia del OpenAPI registrado por Fastify. El snapshot actual contiene 199 paths. Incluye las rutas nativas y las familias de video, sistema y datos. Las guías explican el uso; la referencia muestra el contrato que el backend declara.
Abrir Swagger de mi instalación · Consultar OpenAPI de mi instalación
Autenticación
Sección titulada «Autenticación»| Familia | Autenticación |
|---|---|
/v1 |
Bearer con clave API |
/video/v1 |
Basic con ID y secreto del token |
/system/v1 |
Basic con ID y secreto del token |
/data/v1 |
Basic con ID y secreto del token |
/dashboard |
Sesión HttpOnly y protección CSRF para escrituras |
| Reproducción | Según la política y los tokens del playback ID |
Las declaraciones de seguridad del esquema pueden ser menos específicas en algunas rutas internas. Usa esta tabla y el control de autorización real del servidor como referencia para esas familias. No envíes credenciales administrativas al reproductor ni al navegador.
Actualiza la copia
Sección titulada «Actualiza la copia»Desde la raíz del repositorio:
pnpm docs:sync-apipnpm build:docsLa exportación registra las rutas sin abrir un puerto ni consultar datos de la aplicación. No necesita una API encendida. Conserva el archivo generado apps/docs/schema/openapi.json en el mismo cambio que las rutas que lo modifican.
La referencia refleja los schemas que declaran las rutas. No añade campos ni garantías que el backend no describa. Los recursos del SDK y sus extensiones se documentan también en packages/sdk/README.md.
Lee la referencia junto a las guías
Sección titulada «Lee la referencia junto a las guías»Los schemas de algunas rutas no declaran todos los cuerpos o respuestas que valida el handler. La copia se exporta tal como está registrada; no completa esos huecos ni prueba el runtime. Usa los ejemplos y límites de subidas, Consumo, comparaciones y notificaciones para su interpretación. Consulta además el estado de validación.