菜单
Explica cómo usar la API REST de FacturaScripts para listar, crear, modificar y eliminar registros, y cómo añadir endpoints personalizados desde un plugin. Úsalo cuando el usuario pregunte sobre la API REST, endpoints, autenticación con API key, o cómo crear endpoints personalizados en un plugin.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Crea un modelo de FacturaScripts con su clase PHP y archivo XML de tabla.
Configura la ruta de módulos MCP locales privados en ~/.fs-claude.json
Redacta en pantalla (sin crear ningún archivo) un texto en formato markdown, listo para copiar y pegar, que explica las novedades, mejoras y correcciones de un plugin o proyecto de FacturaScripts a partir de un rango de commits o de versiones. Activa esta skill siempre que el usuario pida "redacta las novedades", "escribe la noticia de los cambios", "genera el changelog", "qué ha cambiado desde la versión X", "resume los cambios entre la versión X y la Y", "prepara el anuncio de la nueva versión", o cualquier variación en la que se pida comunicar qué se ha hecho en un rango de commits o entre dos versiones.
Guía para añadir una nueva conexión de FacturaScripts al archivo de configuración
Sincroniza modelos del MCP fs-mcp con sus fuentes (FacturaScripts core o plugins privados). Detecta columnas nuevas/modificadas/eliminadas, mantiene las descripciones unificadas en los archivos de overrides, regenera la metadata y compila si hace falta. Soporta uno o varios modelos, ruta local o URL de GitHub, y un modo "refresh masivo" para auditar todos los modelos del catálogo y actualizar la versión registrada de FacturaScripts.
Responde preguntas sobre cómo usar FacturaScripts consultando la documentación oficial de usuarios a través del agente especializado `docs-expert`. ACTIVAR SIEMPRE que el usuario pregunte cómo hacer una operación, dónde encontrar una función, cómo fluye un proceso (presupuesto→factura), cómo gestionar clientes, inventario, compras, contabilidad, o cualquier aspecto práctico de uso del ERP. También activar cuando Claude necesite explorar la documentación de usuario antes de responder sobre procedimientos — no esperar a que el usuario pregunte explícitamente. No esperes a que mencione "documentación" — si la pregunta o tarea involucra procedimientos operativos en FacturaScripts, activa esta skill.
| name | api-rest |
| description | Explica cómo usar la API REST de FacturaScripts para listar, crear, modificar y eliminar registros, y cómo añadir endpoints personalizados desde un plugin. Úsalo cuando el usuario pregunte sobre la API REST, endpoints, autenticación con API key, o cómo crear endpoints personalizados en un plugin. |
La API REST de FacturaScripts permite acceder, crear, modificar y eliminar datos desde aplicaciones externas. La URL base siempre es {url-instalacion}/api/3.
Token: {tu-api-key} en cada petición.GET /api/3/impuestos
Por defecto devuelve 50 registros. Usa limit y offset para paginar:
GET /api/3/impuestos?limit=10&offset=0 # página 1
GET /api/3/impuestos?limit=10&offset=10 # página 2
GET /api/3/impuestos?limit=10&offset=20 # página 3
El total de registros disponibles se devuelve en la cabecera X-Total-Count.
# filtro por valor exacto
GET /api/3/impuestos?filter[codimpuesto]=IVA21
# varios filtros (AND por defecto)
GET /api/3/impuestos?filter[codimpuesto]=IVA21&filter[tipo]=1
# operadores de comparación
GET /api/3/productos?filter[precio_gt]=100 # precio > 100
GET /api/3/productos?filter[precio_gte]=100 # precio >= 100
GET /api/3/productos?filter[precio_lt]=50 # precio < 50
GET /api/3/productos?filter[precio_lte]=50 # precio <= 50
GET /api/3/productos?filter[referencia_neq]=X # referencia != X
GET /api/3/productos?filter[referencia_like]=pez # referencia contiene "pez"
# cambiar AND por OR entre filtros
GET /api/3/divisas?filter[descripcion_like]=PESO&filter[tasaconv_gt]=2&operation[tasaconv_gt]=OR
# ordenar por un campo
GET /api/3/divisas?sort[coddivisa]=DESC
# ordenar por varios campos
GET /api/3/productos?sort[precio]=ASC&sort[stockfis]=DESC
La consulta se hace por la clave primaria del modelo:
GET /api/3/impuestos/IVA21
GET /api/3/clientes/CLI001
Si necesitas buscar por otro campo, primero filtra el listado para obtener la clave primaria:
# buscar cliente por teléfono
GET /api/3/clientes?filter[telefono1]=666
# → obtenemos codcliente → luego:
GET /api/3/clientes/codcliente-obtenido
POST /api/3/divisas
Content-Type: application/x-www-form-urlencoded
coddivisa=123&descripcion=Divisa+123
Los datos se envían como form URL encoded, aunque la respuesta siempre es JSON. Solo son obligatorios los campos que no pueden ser nulos en el modelo.
PUT /api/3/divisas/123
Content-Type: application/x-www-form-urlencoded
descripcion=Divisa+-+123
Solo se envían los campos que se quieren cambiar, no es necesario enviar todos.
DELETE /api/3/divisas/123
Devuelve HTTP 200 si se eliminó correctamente, o un código de error con el mensaje JSON.
La lista de todos los recursos (endpoints) disponibles se consulta directamente:
GET /api/3
fsmaker api
Genera automáticamente los endpoints REST para los modelos del plugin.
<?php
namespace FacturaScripts\Plugins\MiPlugin;
use FacturaScripts\Core\Controller\ApiRoot;
use FacturaScripts\Core\Kernel;
use FacturaScripts\Core\Template\InitClass;
class Init extends InitClass
{
public function init(): void
{
Kernel::addRoute('/api/3/mi-endpoint', 'ApiControllerPruebas', -1);
ApiRoot::addCustomResource('mi-endpoint');
}
}
Crear Controller/ApiControllerPruebas.php en el plugin:
<?php
namespace FacturaScripts\Plugins\MiPlugin\Controller;
use FacturaScripts\Core\Template\ApiController;
class ApiControllerPruebas extends ApiController
{
protected function runResource(): void
{
// lógica del endpoint personalizado
$this->response()->json(['hola' => 'mundo']);
}
}
El endpoint quedará disponible en:
GET /api/3/mi-endpoint
Para consultar la documentación oficial completa sobre la API REST de FacturaScripts, invoca el agente docs-expert que te proporcionará detalles completos directamente desde la documentación oficial del framework.