Official Omnifox SDKs for Node.js, Python and PHP
What the official Omnifox SDKs are, what you need to use them, and when an SDK is a better choice than calling the API with curl.
Watch this step in the video · Official SDKs: Node, Python and PHP
Omnifox publishes three official SDKs that wrap the REST API v1 so you don't have to build HTTP requests by hand:
- Node.js:
@omnifox/sdk, published on npm. - Python:
omnifox, published on PyPI. - PHP:
omnifox/sdk, published on Packagist (Composer). Source code: github.com/omnifoxapp-code/omnifox-sdk-php.
All three are on version 0.4 and cover the whole platform: inbox, contacts, CRM, boards and projects, calendar and appointments, catalog, orders and quotes, broadcasts, workflows, webhooks, and reports.
What they solve
- Authentication and retries. They set the
Authorization: Bearerheader and retry on their own on429(honoringRetry-After) and on transient5xxerrors. - Pagination. They walk long lists without you keeping track of pages or cursors.
- Typed errors. Instead of a loose JSON blob, you get an exception with the code, the HTTP status, and the per-field errors.
- Things the API requires that aren't obvious. For example, four endpoints require the workspace id inside the body even when the token is already pinned to one; the SDKs fill it in for you.
Requirements
- A plan with API Access: available from Crece up (Crece, Escala, and Exclusivo). Lite, Impulsa, and Conecta don't include it.
- An API key created in Settings → Development → API Keys.
- Node.js 20 or higher for the Node SDK; Python 3.9 or higher for the Python one; PHP 8.1 or higher (with Composer) for the PHP one.
Installation
# Node.js
npm install @omnifox/sdk
# Python
pip install omnifox
# PHP
composer require omnifox/sdk
Important about the key
None of the SDKs reads environment variables on its own. The key always has to be passed to the constructor. If you store the token in OMNIFOX_API_KEY, you are the one who reads it and hands it to the client.
What the SDKs don't do
- They don't upload files. Attachments travel as a URL or as a typed payload; a real upload is multipart and no SDK implements it.
- They don't expose the Team module or Co-browse.
- They don't replace webhooks: to find out about events in real time, receiving a webhook is still better than polling in a loop.
Tips
- If you're only going to make two or three calls,
curlor your language's HTTP client is enough. The SDK pays off when pagination, retries, and several modules are involved. - If what you want is for an AI assistant to operate on Omnifox, look at the MCP server: it requires no code.
Related articles
- Omnifox Node.js SDK: installation and first calls
- Omnifox Python SDK: sync and async clients
- PHP SDK quickstart and Laravel setup
- What the Omnifox MCP server is and what it's for
Related articles
-
How to connect integrations and external apps
Connect Omnifox with your favorite tools from the integrations catalog in just a few steps.
-
Integrations and API complete guide
Integrations and API in depth, in 30 chapters: API keys, real calls, signed webhooks, n8n, MCP and SDKs, all really working.
-
Connecting Omnifox to Azur, Siigo, Alegra, QuickBooks or another accounting system or ERP
Omnifox doesn't have a native connector for accounting systems or ERPs today. Here's how to connect them anyway with workflows, the HTTP node, n8n, Make, Zapier or the API, with examples.
-
Generate and use API keys and webhooks
Create API keys to access Omnifox programmatically and set up webhooks to receive real-time events.
-
Getting started with integrations (webhook / OAuth / API key)
Connect Omnifox with your other tools: what's available today, what's coming soon, and when to use a webhook, an OAuth connection or an API key.