SDKs oficiales de Omnifox para Node.js, Python y PHP
Qué son los SDKs oficiales de Omnifox, qué necesitas para usarlos y cuándo conviene un SDK en lugar de llamar a la API con curl.
Mira este paso en el video · SDK oficiales: Node, Python y PHP
Omnifox publica tres SDKs oficiales que envuelven la API REST v1 para que no tengas que armar peticiones HTTP a mano:
- Node.js:
@omnifox/sdk, publicado en npm. - Python:
omnifox, publicado en PyPI. - PHP:
omnifox/sdk, publicado en Packagist (Composer). Código fuente: github.com/omnifoxapp-code/omnifox-sdk-php.
Los tres van por la versión 0.4 y cubren la plataforma completa: bandeja de entrada, contactos, CRM, tableros y proyectos, agenda y citas, catálogo, pedidos y cotizaciones, difusiones, flujos, webhooks y reportes.
Qué resuelven
- Autenticación y reintentos. Ponen el encabezado
Authorization: Bearery reintentan solos ante429(respetandoRetry-After) y ante errores5xxpasajeros. - Paginación. Recorren listados largos sin que tú lleves la cuenta de páginas ni cursores.
- Errores tipados. En vez de un JSON suelto, recibes una excepción con el código, el estado HTTP y los errores por campo.
- Cosas que la API pide y no son obvias. Por ejemplo, cuatro endpoints exigen el id del espacio de trabajo dentro del cuerpo aunque el token ya esté fijado a uno; los SDKs lo rellenan por ti.
Requisitos
- Un plan con Acceso a API: disponible desde Crece (Crece, Escala y Exclusivo). Lite, Impulsa y Conecta no lo incluyen.
- Una clave de API creada en Configuración → Desarrollo → API Keys.
- Node.js 20 o superior para el SDK de Node; Python 3.9 o superior para el de Python; PHP 8.1 o superior (con Composer) para el de PHP.
Instalación
# Node.js
npm install @omnifox/sdk
# Python
pip install omnifox
# PHP
composer require omnifox/sdk
Importante sobre la clave
Ninguno de los SDKs lee variables de entorno por su cuenta. La clave hay que pasarla siempre al constructor. Si guardas el token en OMNIFOX_API_KEY, eres tú quien lo lee y se lo entrega al cliente.
Lo que los SDKs no hacen
- No suben archivos. Los adjuntos viajan como URL o como carga tipada; una subida real es multipart y ningún SDK la implementa.
- No exponen el módulo Team ni Co-browse.
- No reemplazan a los webhooks: para enterarte de eventos en tiempo real sigue siendo mejor recibir un webhook que consultar en bucle.
Consejos
- Si solo vas a hacer dos o tres llamadas,
curlo el cliente HTTP de tu lenguaje alcanzan. El SDK gana cuando hay paginación, reintentos y muchos módulos de por medio. - Si lo que quieres es que un asistente de IA opere sobre Omnifox, mira el servidor MCP: no requiere escribir código.
Artículos relacionados
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.