Construye sobre Forz
Sincroniza Forz con tu ERP, crea trabajos desde tu propio flujo de reservas o dale las llaves a tu agente de IA. La API pública v2 y la CLI de Forz de código abierto vienen con Forz, sin un nivel adicional aparte.
API REST
API pública v2Una API JSON versionada sobre HTTPS con referencia OpenAPI 3. Los registros con los que trabaja la oficina quedan al alcance de tu código: clientes, sitios, trabajos, presupuestos, facturas, órdenes de compra y más.
- Autenticación Bearer con claves de API que creas en Forz
- Paginación por cursor en cada listado, con filtros, ordenamiento y búsqueda de texto en los recursos principales
- Concurrencia optimista con ETag en actualizaciones y eliminaciones
- Claves de idempotencia en las creaciones financieras
- Errores problem+json (RFC 9457) con códigos estables y documentados
- Encabezados de límite de solicitudes en cada respuesta, más un servidor de staging
CLI de Forz
npm: forz-cliUna herramienta de línea de comandos y biblioteca cliente en TypeScript, sin dependencias, que incorpora las convenciones de la API para que nunca tengas que armar a mano un cursor, un ETag o una clave de idempotencia.
- Lista, consulta, crea, actualiza y elimina cada recurso principal desde la terminal
- Importa ForzClient en tu propio código Node o TypeScript
- Lee cuerpos JSON desde un archivo, un argumento o stdin para tus scripts
- Vía directa: forz raw para cualquier endpoint de la referencia
Agentes de IA
Trae el tuyoEl paquete de la CLI incluye una skill de Claude Code y un archivo AGENTS.md, para que Claude, ChatGPT, Codex, Grok o tu propio agente operen Forz con tu clave de API y tu cuenta de IA.
- Forz no recarga ni mide la factura de tu proveedor de IA
- Las instrucciones para agentes cubren las reglas de ETag, idempotencia y paginación
- Un servidor Model Context Protocol (MCP) de Forz está planificado, todavía no disponible
Tu primera llamada a la API
- Confirma con nuestro equipo que el acceso a la API está activado en tu cuenta de Forz.
- Crea una clave de API en Configuraciones > Claves API.
- Instala la CLI desde npm y guarda la clave con
forz login, o envíala como token Bearer desde tu propio código. - Prueba primero contra staging y después apunta la misma integración a producción.
# instala la CLI y guarda tu clave
npm install -g forz-cli
forz login --token <tu-clave-api>
forz whoami
# lista clientes y crea un trabajo desde un archivo
forz customers list --limit 25 --q "Harbor"
forz jobs create --body @nuevo-trabajo.json
# o llama a la API REST directamente
curl https://app.forz.io/api/v2/customers \
-H "Authorization: Bearer <tu-clave-api>" Qué cubre la API
Recursos disponibles hoy en la API pública v2. La referencia detalla cada campo, filtro y código de error de cada uno.
- Clientes
- Sitios
- Contactos
- Trabajos
- Trabajos recurrentes
- Presupuestos
- Facturas
- Facturas recurrentes
- Órdenes de venta
- Órdenes de compra
- Proveedores
- Artículos
- Activos
- Sistemas
- Tareas
- Tickets
- Prospectos
- Oportunidades
- Proyectos
- Notas
- Campos personalizados
- Listas de referencia
¿Te falta un endpoint? Cuéntanos qué estás construyendo y revisa la hoja de ruta pública para ver lo que viene, incluido el servidor MCP.
Construye tu integración sobre Forz
Habla con nuestro equipo sobre el acceso a la API, las credenciales de staging y lo que necesita tu integración. La API y la CLI vienen con Forz.