SDKs oficiais da Omnifox para Node.js, Python e PHP
O que são os SDKs oficiais da Omnifox, o que você precisa para usá-los e quando vale mais a pena um SDK do que chamar a API com curl.
Veja este passo no vídeo · SDKs oficiais: Node, Python e PHP
A Omnifox publica três SDKs oficiais que envolvem a API REST v1 para que você não precise montar requisições HTTP na mão:
- Node.js:
@omnifox/sdk, publicado no npm. - Python:
omnifox, publicado no PyPI. - PHP:
omnifox/sdk, publicado no Packagist (Composer). Código-fonte: github.com/omnifoxapp-code/omnifox-sdk-php.
Os três estão na versão 0.4 e cobrem a plataforma inteira: caixa de entrada, contatos, CRM, quadros e projetos, agenda e compromissos, catálogo, pedidos e orçamentos, transmissões, fluxos, webhooks e relatórios.
O que eles resolvem
- Autenticação e novas tentativas. Colocam o cabeçalho
Authorization: Bearere repetem a chamada sozinhos diante de429(respeitando oRetry-After) e de erros5xxpassageiros. - Paginação. Percorrem listagens longas sem que você tenha que controlar páginas nem cursores.
- Erros tipados. Em vez de um JSON solto, você recebe uma exceção com o código, o status HTTP e os erros por campo.
- Coisas que a API exige e não são óbvias. Por exemplo, quatro endpoints exigem o id do espaço de trabalho dentro do corpo mesmo que o token já esteja fixado a um; os SDKs preenchem isso para você.
Requisitos
- Um plano com Acesso à API: disponível a partir do Crece (Crece, Escala e Exclusivo). Lite, Impulsa e Conecta não incluem.
- Uma chave de API criada em Configurações → Desenvolvimento → API Keys.
- Node.js 20 ou superior para o SDK de Node; Python 3.9 ou superior para o de Python; PHP 8.1 ou superior (com Composer) para o de PHP.
Instalação
# Node.js
npm install @omnifox/sdk
# Python
pip install omnifox
# PHP
composer require omnifox/sdk
Importante sobre a chave
Nenhum dos SDKs lê variáveis de ambiente por conta própria. A chave sempre precisa ser passada ao construtor. Se você guarda o token em OMNIFOX_API_KEY, é você quem lê e entrega o valor ao cliente.
O que os SDKs não fazem
- Não enviam arquivos. Os anexos viajam como URL ou como carga tipada; um upload real é multipart e nenhum SDK implementa isso.
- Não expõem o módulo Team nem o Co-browse.
- Não substituem os webhooks: para saber de eventos em tempo real, continua sendo melhor receber um webhook do que consultar em loop.
Dicas
- Se você vai fazer só duas ou três chamadas, o
curlou o cliente HTTP da sua linguagem já bastam. O SDK compensa quando há paginação, novas tentativas e vários módulos envolvidos. - Se o que você quer é que um assistente de IA opere sobre a Omnifox, veja o servidor MCP: não exige escrever código.
Artigos relacionados
- SDK de Node.js da Omnifox: instalação e primeiras chamadas
- SDK de Python da Omnifox: cliente síncrono e assíncrono
- SDK de PHP: início rápido e configuração no Laravel
- O que é o servidor MCP da Omnifox e para que serve
Artigos relacionados
-
Como conectar integrações e apps externos
Conecte o Omnifox às suas ferramentas favoritas a partir do catálogo de integrações em poucos passos.
-
Integrar o Omnifox com Azur, Siigo, Alegra, QuickBooks ou outro sistema contábil ou ERP
O Omnifox não tem hoje um conector nativo com sistemas contábeis ou ERP. Veja como fazer essa conexão mesmo assim com fluxos de trabalho, o nó HTTP, n8n, Make, Zapier ou a API, com exemplos.
-
Guia completo de integrações e API
Integrações e API a fundo, em 30 capítulos: chaves de API, chamadas reais, webhooks assinados, n8n, MCP e SDKs, tudo funcionando de verdade.
-
Gerar e usar API keys e webhooks
Crie chaves de API para acessar o Omnifox por código e configure webhooks para receber eventos em tempo real.
-
Introdução às integrações (webhook / OAuth / chave de API)
Conecte o Omnifox às suas outras ferramentas: o que está disponível hoje, o que chega em breve e quando usar um webhook, uma conexão OAuth ou uma chave de API.