DocumentacionAPI para FacturaScripts
Plugin que integra Swagger UI para visualizar y probar la API REST de FacturaScripts.
Uso Básico
- Instala el plugin desde el panel de administración
- Ve a
Administrador > Swagger
- Verás la interfaz de Swagger UI con todos los endpoints disponibles
Funcionalidades
- Visualiza todos los endpoints de la API de FacturaScripts
- Prueba las llamadas directamente desde la interfaz
- Filtra endpoints usando el buscador
- Exporta la documentación en formato JSON
Endpoints
La documentación se genera automáticamente basándose en los modelos y endpoints disponibles en tu instalación de FacturaScripts.
Obtener JSON de la API
Para obtener la documentación en formato JSON:
GET /swagger?action=get-json
Filtrar Endpoints
Para filtrar endpoints específicos:
GET /swagger?action=get-json&filter=clientes
Interfaz Swagger
- Los endpoints están agrupados por tipo (Modelos/Custom)
- Cada endpoint muestra:
- Método HTTP
- URL
- Parámetros requeridos
- Formato de respuesta
- Ejemplos
Soporte
- Email: tono@beply.es