La API REST de Omnifox: introducción y requisitos de plan

Qué es la API REST de Omnifox, qué plan necesitas (desde Crece), cómo autenticar con la cabecera X-API-Key y dónde está la documentación.

Jun 26, 2026

Mira este paso en el video · Requisitos: plan y permisos

¿Qué es la API REST de Omnifox?

La API REST te permite leer y crear datos de tu workspace —contactos, conversaciones, mensajes, CRM, proyectos— desde tu propio código o desde una herramienta no-code. Es la base para automatizar flujos, sincronizar tu CRM o construir integraciones a medida.

Esta guía cubre lo esencial para empezar: requisitos de plan, autenticación y dónde está la documentación.

Requisitos de plan

El acceso a la API es una función de plan llamada Acceso a API. Está disponible desde el plan Crece en adelante (Crece, Escala y Exclusivo). Los planes Lite y Conecta no lo incluyen.

Si tu plan no lo tiene, la sección Claves de API aparecerá bloqueada y cualquier llamada a la API responderá con el código PLAN_API_ACCESS_REQUIRED.

Antes de empezar

  • Rol Administrador del workspace.
  • Un plan con Acceso a API.
  • Una clave de API ya creada (ver más abajo).

Pasos

1. Crea tu clave de API

  1. Ve a Configuración → API Keys → Nueva clave de API.
  2. Dale un nombre, elige el workspace, una fecha de expiración y marca solo los scopes que necesites: read:contacts, write:contacts, read:messages, write:messages, read:channels, read:crm, write:crm, read:projects, write:projects.
  3. Copia la clave de inmediato: solo se muestra una vez.

2. Autentica tus llamadas

Envía el token en la cabecera Authorization: Bearer en cada petición:

curl https://omnifox.io/api/v1/contacts \
  -H "Authorization: Bearer TU_TOKEN_AQUI"

3. Conoce la URL base

Todos los endpoints viven bajo /api/v1/. Por ejemplo: /api/v1/contacts, /api/v1/conversations, /api/v1/messages.

4. Lee la documentación

La referencia interactiva está en omnifox.io/docs, y la especificación OpenAPI en omnifox.io/api-docs/openapi.json para importar en Postman o generar un SDK.

Verificación

Una llamada GET /api/v1/contacts con una clave válida devuelve 200 y un JSON con tus contactos. Las respuestas vienen envueltas en { "success": true, "data": ... }.

Si algo no funciona

  • PLAN_API_ACCESS_REQUIRED: tu plan no incluye Acceso a API. Sube a Crece o superior.
  • 401: falta la cabecera Authorization: Bearer, la clave expiró o fue revocada.
  • 403: la clave no tiene el scope necesario para ese endpoint; edítala y añade el scope.
  • 404 en un endpoint: recuerda que la ruta es /api/v1/..., no /v1/....

Consejos

  • Crea una clave distinta por integración y dale solo los scopes mínimos.
  • Para recibir eventos en tiempo real (mensajes nuevos, etc.) usa Webhooks en lugar de hacer polling.

Artículos relacionados

¿Te fue útil?

Artículos relacionados

Escríbenos por WhatsApp