Explorador interactivo (Scalar)

Scalar es el explorador interactivo integrado en la API. Está disponible en la ruta /scalar de la instancia y permite consultar todos los endpoints disponibles, construir peticiones con el formulario y ejecutarlas contra el servidor en tiempo real, sin necesidad de herramientas externas.

Tip

La API también expone Swagger UI en /swagger. Ambas herramientas leen el mismo catálogo de endpoints, pero Scalar ofrece autenticación persistente entre sesiones y una navegación por módulos más cómoda.

Autenticación

La API usa JWT Bearer. Scalar está configurado para recordar el token entre sesiones gracias a la autenticación persistente, por lo que solo necesitas pegarlo una vez por navegador.

1. Obtén un token llamando al endpoint POST /login con tus credenciales.

2. En Scalar, haz clic en el botón Authentication (esquina superior derecha).

3. Selecciona el esquema Bearer y pega el token en el campo de valor — sin el prefijo Bearer .

4. Haz clic en Save. El token queda guardado en el navegador y se enviará automáticamente en todas las peticiones.

Caution

El token expira a los 60 minutos. Cuando una petición devuelva 401 Unauthorized, vuelve al paso 1 para renovarlo.

Ejecutar una petición

1. Localiza el endpoint en el panel izquierdo. Los endpoints están agrupados por módulo (Ventas, Contabilidad, etc.) en el mismo orden que esta documentación.
2. Haz clic sobre el endpoint para expandirlo.
3. Rellena los parámetros requeridos en el formulario. Los campos de tipo string muestran "string" como valor de ejemplo; los campos de tipo enum muestran un desplegable con sus valores posibles.
4. Para endpoints con cuerpo JSON (POST/PUT), el panel Body muestra una plantilla con todos los campos del modelo. Modifica solo los que necesites.
5. Pulsa Send. La respuesta aparece en el panel derecho con el código HTTP, las cabeceras y el JSON formateado.

Note

Las peticiones salen directamente desde tu navegador hacia el servidor de la API, sin pasar por ningún proxy intermedio. Esto significa que la cabecera Authorization no se pierde en el camino y que la URL que ves en el formulario es exactamente la URL que se llama.

Filtros aplicados al catálogo de endpoints

Scalar lee el mismo documento OpenAPI que Swagger UI (/swagger/v1/swagger.json), pero ese documento ya viene filtrado por la API:

• Endpoints de cliente específico ([ClientFeature("...")]) no aparecen — son funcionalidades privadas por cliente.
• Módulos privados (B2BTandem, TPVTandem, TConnect y similares) tampoco aparecen.
• En instalaciones monoempresa, los parámetros codigoEmpresa se ocultan automáticamente del formulario.

Diferencias con Swagger UI

	Scalar (/scalar)	Swagger UI (/swagger)
Autenticación persistente	✅ Se guarda en el navegador	❌ Se pierde al recargar
Navegación	Por módulos, panel lateral	Lista plana expandible
Enums	Desplegable con valores	Desplegable con valores
Ejemplos de body	Plantilla con todos los campos	Plantilla con todos los campos
Peticiones directas (sin proxy)	✅	✅