Cargando

Saltar al contenido

Usar UTILIA OS Desarrolladores

Entrar Únete a la lista de espera

Empezar

API

Conectar

Insertar en tu web

Cambios

Cargando la pantalla

¿Aún no usas UTILIA OS?

Únete a la lista de espera

Aviso legal
Privacidad
Cookies

© 2026 UTILIA SERVICIOS IA S. COOP. CAN.

Documentación
Para desarrolladores
API REST

API REST

Endpoints de la API externa (con clave de API) y de la API del panel (con sesión), agrupados por área del producto.

No todo lo de esta sección está en todos los planes: cada artículo indica en cuáles se incluye. Ver precios

Qué conecta la API REST

Recibe de

Aplicaciones externas
Cada aplicación recibe aquí su clave de API, sus permisos y su dirección de avisos.

API externa

Lo que tu aplicación lee y escribe en UTILIA OS con su clave de API.

Envía a

CRM
Tu aplicación da de alta clientes y leads, y cualifica o convierte los leads en contactos.
Finanzas
Las facturas, suscripciones y cobros de tu aplicación se emiten con la numeración de tu organización.
Tickets de soporte
Los tickets que abre tu aplicación llegan a la bandeja de tu equipo.
Presupuestos y firma
Tu aplicación comenta los presupuestos en la conversación visible para el cliente y consulta sus firmas.
Avisos a tu servidor
Lo que pasa en UTILIA OS vuelve a tu aplicación como avisos firmados.

Empieza por aquí

Usuarios externos

Identifica a los usuarios de tu aplicación, vincúlalos a una ficha de cliente del CRM y consulta el listado con /external/v1/users.

CRM

Clientes del CRMAPI externa /external/v1/clients: alta, listado, búsqueda por NIF, contactos vinculados, grupos de empresas, desactivación y avisos CLIENT_*.
Contactos del CRMAPI externa /external/v1/contacts para herramientas de envío de correo: listado, sincronización por cambios, bajas, reactivaciones y avisos CONTACT_*.
Leads del CRMAPI externa /external/v1/leads para prospección y sincronización con otro CRM: listado, sincronización por cambios, cualificar, descartar, convertir y avisos LEAD_*.
Analítica de oportunidadesEndpoints de la API del panel que alimentan la vista Análisis de Oportunidades del CRM: listado, contadores, estadísticas del embudo, previsión y exportación.

Facturación y cobros

Facturar y cobrar desde tu aplicaciónRecorrido completo para facturar y cobrar desde tu aplicación con UTILIA OS: identificar al usuario, guardar la tarjeta, emitir la factura y cobrar la cuota.
FacturasAPI externa /external/v1/invoices: crear, emitir y enviar, listar, detalle, PDF, anular y estadísticas, con el plan y los permisos que exige cada endpoint.
Acciones sobre una factura emitidaEnviar por correo, registrar un cobro fuera de la pasarela, devolver dinero, obtener el enlace público y cobrar sin el usuario delante, desde la API externa /external/v1/invoices/:id.
Cobro de facturas con el usuario delanteCobra una factura con el usuario delante, con tarjeta guardada o nueva, y consulta el historial de intentos de cobro.
Métodos de pagoAPI externa /external/v1/payment-methods: guardar tarjetas, listarlas, marcar la predeterminada y desvincularlas, con el plan y los permisos que exige cada endpoint.
Autorizaciones de cobroRecoger, consultar y retirar la autorización que permite cobrar a un usuario sin que esté delante: texto de consentimiento, prueba legal y alcances, en /external/v1/payment-authorizations.
SuscripcionesAlta, cambios, pausa, baja y facturas de las cuotas recurrentes de los usuarios de una aplicación externa, en /external/v1/subscriptions.
Cobros programadosProgramar el cobro de una factura para una fecha futura, cancelarlo y adelantar un reintento, desde la API externa /external/v1.
Cancelación de reembolsosCómo se previsualiza y se cancela un reembolso de factura desde el panel o por MCP (no está en la API externa) y qué contiene el aviso INVOICE_REFUND_CANCELLED.

Presupuestos

Comentarios de presupuestoLista y crea comentarios visibles para el cliente en un presupuesto con /external/v1/budgets/:budgetId/comments y los permisos crm:budgets:comments:*.
Firmas de presupuestoLista, consulta y verifica las firmas electrónicas de un presupuesto con /external/v1/budgets/:budgetId/signatures y los permisos crm:budgets:signatures:*.

Tickets de soporte

Tickets de soporteEndpoints para crear, consultar, cerrar y reabrir tickets de soporte, añadirles mensajes y recibir sus cambios en tiempo real, con los permisos support:tickets:*.
Sugerencias con IA en ticketsRellena el formulario de un ticket con IA a partir de texto, audio o imágenes del usuario, y registra qué hizo con las sugerencias. Permiso support:tickets:ai.
Transcripción de audio en ticketsConvierte en texto el audio que graba el usuario, en el momento (hasta 10 MB) o en segundo plano, para dictar tickets por voz. Permiso support:tickets:ai.

Archivos

ArchivosSube archivos, consulta la cuota y obtén direcciones de descarga firmadas desde tu aplicación con /external/v1/files y los permisos fm:files:*.

Errores de tu aplicación

Errores del navegador (SDK y widget)Envía en lotes los errores que se producen en el navegador del usuario (SDK, widget o tu propia interfaz) para verlos en la ficha de tu aplicación.
Errores de tu aplicaciónEndpoints para que tu servidor informe de sus errores a UTILIA OS, los liste y consulte sus estadísticas, con los permisos analytics:errors:*.
Pestaña de errores de la aplicaciónQué hace tu equipo, desde la ficha de la aplicación en UTILIA OS, con los errores que envía tu integración, y qué avisos recibe tu servidor por cada acción.

Marketing e IA

Marketing: API y herramientas MCPAPI y herramientas MCP de Marketing: informes de campañas, pruebas A/B, cierre comercial, automatizaciones, segmentos y exportación de informes.
API REST de AI StudioAPI del panel de AI Studio: activos, versiones, colecciones, vínculos, comparticiones, uso y reacciones, marketplace y cambios en tiempo real.
Analítica de IAConsulta desde tu aplicación el resumen y la evolución diaria de su propio uso de IA con /external/v1/ai-analytics y el permiso analytics:ai:read.

Aplicaciones, permisos y métricas

Panel de aplicaciones externasCómo se crea y se configura una aplicación externa en UTILIA OS: claves, permisos de la API, avisos a tu servidor, usuarios externos, facturación y métricas, con los endpoints que usa el panel.
API de administración de integracionesReferencia de los endpoints de administración para dar de alta, configurar y vigilar las aplicaciones externas de tu organización; se llaman con la sesión de un usuario, no con X-Api-Key.
Permisos de la API (scopes)Cómo conceder y retirar permisos a una aplicación externa: los 56 permisos, sus tipos, los 14 que solo concede un Super Administrador, el recorte por plan y la auditoría.
Catálogo de permisos de la APILos 56 permisos de la API externa, los 14 que solo concede un Super Administrador, su desglose por área y tipo, y cómo los marca el plan.
Métricas de la APIEndpoints de la API del panel para consultar el uso que hace una aplicación externa de la API: peticiones, latencia, errores, endpoints, avisos e IA.