Explorar la API con Swagger UI (/docs) y el archivo OpenAPI
Cómo usar la documentación interactiva de la API de Omnifox para probar endpoints sin escribir código.
Mira este paso en el video · La documentación de la API
Omnifox publica una documentación interactiva de toda su API REST, generada a partir de un archivo OpenAPI, donde puedes ver cada endpoint, sus parámetros, el esquema de request/response, y hasta probarlo en vivo desde el navegador.
Cómo acceder
- Documentación interactiva (Swagger UI):
https://app.omnifox.io/docs - Archivo OpenAPI en crudo (JSON):
https://app.omnifox.io/api-docs/openapi.json
El archivo OpenAPI es útil para generar un cliente/SDK automáticamente con herramientas como openapi-generator, Postman o Insomnia (importar por URL).
Qué vas a encontrar
- Todos los módulos: Contactos, Conversaciones y Mensajes, CRM, Proyectos/Tableros, Calendario, Reportes, Webhooks, Workflows, Broadcasts, Agentes, Canales, Equipos, Tags y Snippets.
- El formato exacto de respuesta exitosa y de error (sobres
success/dataycode/message/details). - Esquemas reutilizables (
Contact,Conversation,Message,Deal,Board, etc.) para entender la forma de cada recurso.
Ejemplo: probar un endpoint desde Swagger UI
- Entra a
https://app.omnifox.io/docs. - Busca el endpoint, por ejemplo
GET /v1/contacts. - Haz clic en "Try it out", pega tu token Bearer en el botón de autorización (candado) en la parte superior.
- Completa los parámetros que quieras probar (
tag,per_page, etc.) y ejecuta. - Swagger UI te muestra el
curlequivalente, la URL final y la respuesta real de tu workspace.
Consejos
- Usa el botón de autorización una sola vez por sesión de navegador: el token queda aplicado a todos los endpoints que pruebes después.
- Si vas a construir un SDK propio, importa
openapi.jsondirectamente en Postman ("Import > Link") para tener toda la colección actualizada sin mantenerla a mano.
Solución de problemas
- "Try it out" devuelve 401: falta cargar el token Bearer en el botón de autorización, o el token expiró.
- El endpoint que necesito no aparece: la documentación cubre
/api/v1/*; funciones muy nuevas pueden tardar un ciclo de release en aparecer en el spec público.
Artículos relacionados
-
Cómo conectar integraciones y apps externas
Conecta Omnifox con tus herramientas favoritas desde el catálogo de integraciones en pocos pasos.
-
Guía completa de integraciones y API
Integraciones y API a fondo, en 30 capítulos: claves API, llamadas reales, webhooks firmados, n8n, MCP y SDK, todo funcionando de verdad.
-
Integrar Omnifox con Azur, Siigo, Alegra, QuickBooks u otro sistema contable o ERP
Omnifox no tiene hoy un conector nativo con sistemas contables o ERP. Te explicamos cómo conectarlos igual con workflows, el nodo HTTP, n8n, Make, Zapier o la API, con ejemplos.
-
Generar y usar API keys y webhooks
Crea claves de API para acceder a Omnifox por código y configura webhooks para recibir eventos en tiempo real.
-
Introducción a las integraciones (webhook / OAuth / API key)
Conecta Omnifox con tus otras herramientas: qué está disponible hoy, qué llega pronto y cuándo usar un webhook, una conexión OAuth o una clave de API.