A API REST do Omnifox: introdução e requisitos de plano
O que é a API REST do Omnifox, qual plano você precisa (a partir do Crece), como autenticar com o cabeçalho X-API-Key e onde fica a documentação.
Veja este passo no vídeo · Requisitos: plano e permissões
O que é a API REST do Omnifox?
A API REST permite ler e criar os dados do seu workspace —contatos, conversas, mensagens, CRM, projetos— a partir do seu próprio código ou de uma ferramenta no-code. É a base para automatizar fluxos, sincronizar seu CRM ou construir integrações sob medida.
Este guia cobre o essencial para começar: requisitos de plano, autenticação e onde fica a documentação.
Requisitos de plano
O acesso à API é um recurso de plano chamado Acesso à API. Está disponível a partir do plano Crece (Crece, Escala e Exclusivo). Os planos Lite e Conecta não incluem.
Se seu plano não tiver, a seção Chaves de API ficará bloqueada e qualquer chamada à API responderá com o código PLAN_API_ACCESS_REQUIRED.
Antes de começar
- Papel Administrador do workspace.
- Um plano com Acesso à API.
- Uma chave de API já criada (veja abaixo).
Passos
1. Crie sua chave de API
- Vá em Configurações → Chaves API → Nova chave de API.
- Dê um nome, escolha o workspace, uma data de expiração e marque só os escopos necessários:
read:contacts,write:contacts,read:messages,write:messages,read:channels,read:crm,write:crm,read:projects,write:projects. - Copie a chave na hora — ela só é exibida uma vez.
2. Autentique suas chamadas
Envie o token no cabeçalho Authorization: Bearer em cada requisição:
curl https://omnifox.io/api/v1/contacts \
-H "Authorization: Bearer SEU_TOKEN_AQUI"
3. Conheça a URL base
Todos os endpoints ficam sob /api/v1/. Por exemplo: /api/v1/contacts, /api/v1/conversations, /api/v1/messages.
4. Leia a documentação
A referência interativa está em omnifox.io/docs, e a especificação OpenAPI em omnifox.io/api-docs/openapi.json para importar no Postman ou gerar um SDK.
Verificação
Uma chamada GET /api/v1/contacts com uma chave válida retorna 200 e um JSON com seus contatos. As respostas vêm envolvidas em { "success": true, "data": ... }.
Se não funcionar
PLAN_API_ACCESS_REQUIRED: seu plano não inclui Acesso à API. Faça upgrade para Crece ou superior.401: falta o cabeçalhoAuthorization: Bearer, ou a chave expirou ou foi revogada.403: a chave não tem o escopo necessário para aquele endpoint; edite-a e adicione o escopo.404em um endpoint: lembre que a rota é/api/v1/..., não/v1/....
Dicas
- Crie uma chave separada por integração e dê só os escopos mínimos.
- Para receber eventos em tempo real (mensagens novas etc.) use Webhooks em vez de fazer polling.
Artigos relacionados
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.