Cargando

Saltar al contenido

Usar UTILIA OS Desarrolladores

Entrar Empieza tu prueba de 14 días

Empezar

API

Conectar

Publicar en el catálogo

Insertar en tu web

Cambios

Cargando la pantalla

¿Aún no usas UTILIA OS?

Empieza tu prueba de 14 días

Aviso legal
Privacidad
Cookies

© 2026 UTILIA SERVICIOS IA S. COOP. CAN.

Documentación
Para desarrolladores
Empezar a integrar

Empezar a integrar

Los cuatro caminos para integrar, qué credencial te toca, tu primera petición, cómo probarla y diagnosticarla, sus límites y cómo tratar los errores.

Entrar en Creadas por tu empresa

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

Qué alcanza la API externa

Recibe de

Tu aplicación
Llama desde tu servidor con la credencial que te toque según quién llama.

API externa

Las rutas /api/external/v1, con la clave de tu aplicación.

Envía a

Tickets de soporte
Abre tickets en nombre de tus usuarios y sigue sus respuestas.
CRM
Lee y escribe clientes, contactos y leads.
Finanzas
Emite facturas, monta suscripciones y cobra a tus usuarios.
Presupuestos y firma
Lee las firmas de un presupuesto y gestiona sus comentarios visibles para el cliente.
Gestor de archivos
Sube archivos y adjúntalos a los tickets.

Empieza por aquí

Por dónde empezar a integrar

Cuatro caminos según lo que construyes: automatizar tu empresa, tu producto con sus usuarios, conectar una IA o una aplicación para todas las empresas.

General

Elegir credencialLas seis credenciales de UTILIA OS, qué abre cada una y cuál te toca según quién llama: tu aplicación, un programa, una IA o tu web.
Integrar con un asistente de IALa instrucción para pegar en tu asistente de IA y las reglas para que integre con la API sin preguntar a nadie ni romper nada.
Primeros 15 minutos con la APIDel alta de la aplicación a tu primer ticket: identificar al usuario, abrir una incidencia, pedir sugerencias de IA, enviar errores y tratar los fallos.

Probar y diagnosticar

Probar tu integraciónEn cinco minutos: diagnostica tu clave, comprueba una petición sin ejecutarla, ensaya sin escribir, llama y lee el error.
Rutas del diagnósticoReferencia de /me, el diagnóstico y su veredicto, las llamadas rechazadas, el contrato de tu clave y las claves publicadas, con sus cupos.
Comprobar y ensayar sin escribirReferencia de check-request, que dice si una petición pasaría sin ejecutarla, y de la prueba activa, que lee con cada permiso sin devolver datos.
Probar los avisos a tu servidorEnvía a tu servidor un aviso de prueba firmado y comprueba que rechaza los falsos, sin esperar a que ocurra un evento real.
Salud de la aplicaciónCómo vigila UTILIA OS la salud de tu aplicación con su tráfico real, cuándo pasa a Revisar o a No funciona y a quién avisa.
Hallazgos del diagnósticoQué significa cada hallazgo del diagnóstico y cada primer paso del recorrido, quién lo arregla y cómo.

Lo básico de la API

Autenticación con clave de accesoCómo autentica la API externa a tu aplicación con la cabecera X-Api-Key, qué comprueba en cada petición y qué error devuelve cuando algo falla.
Límites de uso y CORSCuántas peticiones admite la clave de tu aplicación, qué pasa al superar el límite, desde qué webs se puede llamar a la API externa y qué permisos admite una clave que va en una página.
Errores, identificador de petición y reintentosCómo es un error de la API externa, qué significa cada errorCode, quién lo arregla, qué cabeceras leer y cuándo merece la pena reintentar.
Dónde va cada parámetro: consulta, cuerpo o rutaDónde espera cada endpoint de la API externa sus parámetros (en la ruta, en la consulta o en el cuerpo) para evitar errores 400 y 404.
Errores frecuentes al integrarLos diez errores que más se repiten en las primeras integraciones con la API externa de UTILIA OS y cómo evitarlos.

Arquitectura

Arquitectura y flujos de una integraciónLos cuatro flujos de una integración con UTILIA OS: tu aplicación llama, UTILIA OS te avisa, la IA trabaja en segundo plano y una persona autoriza con OAuth.
Arquitectura de la plataformaCómo está construido UTILIA OS: un servicio en la nube compartido por varias organizaciones, con los datos de cada una aislados y los módulos conectados entre sí.
Arquitectura de la facturación centralizadaCómo encajan UTILIA OS, tu aplicación y la pasarela de pago al facturar y cobrar: identificadores, puente de identidad, cobro recurrente y avisos.