Los SDK de UTILIA OS
Qué cubren los SDK oficiales de JavaScript y Python, con qué credencial se autentica cada parte y por dónde empezar.
Actualizado el . 3 min de lectura
Incluido en todos los planes. Ver precios
Con los SDK oficiales tu aplicación da de alta a sus usuarios, les abre tickets de soporte, les factura y les cobra, y tus copilotos trabajan con el CRM y Marketing, sin escribir las peticiones a mano. Hay dos: @utilia-os/sdk-js para JavaScript y TypeScript (Node.js 18 o superior) y utilia-sdk para Python (3.9 o superior, con versión asíncrona y síncrona). Los dos comparten numeración y van a la par; la versión vigente es la 4.1.0, y el historial está en Versiones y compatibilidad.
Por encima de la API, los SDK añaden comprobaciones antes de enviar, reintentos con espera creciente, un identificador por petición para seguirla en los registros y un error único y estructurado, UtiliaSDKError. En esta sección, cada página explica un tema para los dos lenguajes, con el código en pestañas: elige tu lenguaje una vez y la documentación lo recordará.
Qué puedes hacer
- Usuarios: identificar a las personas de tu aplicación, el primer paso de todo lo demás.
- Soporte: abrir tickets en su nombre, conversar con el equipo y seguir los cambios en tiempo real, con archivos adjuntos.
- IA: proponer el ticket a partir de texto, audio o capturas, y transcribir notas de voz.
- Facturar y cobrar: emitir facturas con numeración y registro fiscal, enviarlas, entregar su enlace público, guardar tarjetas, cobrar con el usuario delante o sin él, programar cobros, devolver dinero y montar suscripciones con su autorización de cobro.
- CRM: contactos, leads y clientes por la API externa; oportunidades y el resto del CRM por MCP.
- Marketing y otros servicios por MCP: campañas, listas, entregabilidad, calendario laboral, buscador y avisos.
- Avisos a tu servidor: verificar la firma de los webhooks que te envía UTILIA OS, con el evento ya tipado.
Qué credencial usa cada parte
Qué credencial usa cada parte del SDK
API externa · /external/v1
Clave de la aplicación
Carril MCP · sdk.mcp
OAuth de una persona
Avisos · sdk.webhooks
Ninguna
Algunos servicios del SDK (contactos, presupuestos, calendario y ajustes de la organización) apuntan a rutas de la API del panel y hoy no son alcanzables desde el SDK con ninguna de las dos credenciales. El detalle, y qué usar en su lugar, está en la Referencia de métodos.
Por dónde empezar
- Instalar el SDKRequisitos, instalación y primera llamada en JavaScript y Python.
- Configurar el clienteTiempo de espera, reintentos, depuración y autenticación.
- Usuarios externosIdentifica a tus usuarios antes de abrirles tickets o facturarles.
- FacturasEmite, envía, cobra y anula facturas desde tu aplicación.
- Gestionar erroresQué trae UtiliaSDKError y cuándo reintentar.
- Referencia de métodosTodos los servicios y métodos, con su nombre en cada lenguaje.