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.

Jul 11, 2026

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/data y code/message/details).
  • Esquemas reutilizables (Contact, Conversation, Message, Deal, Board, etc.) para entender la forma de cada recurso.

Ejemplo: probar un endpoint desde Swagger UI

  1. Entra a https://app.omnifox.io/docs.
  2. Busca el endpoint, por ejemplo GET /v1/contacts.
  3. Haz clic en "Try it out", pega tu token Bearer en el botón de autorización (candado) en la parte superior.
  4. Completa los parámetros que quieras probar (tag, per_page, etc.) y ejecuta.
  5. Swagger UI te muestra el curl equivalente, 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.json directamente 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.
¿Te fue útil?

Artículos relacionados

Escríbenos por WhatsApp