Explorar a API com o Swagger UI (/docs) e o arquivo OpenAPI
Como usar a documentação interativa da API do Omnifox para testar endpoints sem escrever código.
Veja este passo no vídeo · A documentação da API
O Omnifox publica uma documentação interativa de toda a sua API REST, gerada a partir de um arquivo OpenAPI, onde você pode ver cada endpoint, seus parâmetros, o esquema de request/response, e até testá-lo ao vivo direto do navegador.
Como acessar
- Documentação interativa (Swagger UI):
https://app.omnifox.io/docs - Arquivo OpenAPI bruto (JSON):
https://app.omnifox.io/api-docs/openapi.json
O arquivo OpenAPI é útil para gerar automaticamente um cliente/SDK com ferramentas como openapi-generator, Postman ou Insomnia (importar por URL).
O que você vai encontrar
- Todos os módulos: Contatos, Conversas e Mensagens, CRM, Projetos/Quadros, Calendário, Relatórios, Webhooks, Workflows, Broadcasts, Agentes, Canais, Equipes, Tags e Snippets.
- O formato exato de resposta de sucesso e de erro (envelopes
success/dataecode/message/details). - Esquemas reutilizáveis (
Contact,Conversation,Message,Deal,Board, etc.) para entender o formato de cada recurso.
Exemplo: testar um endpoint pelo Swagger UI
- Acesse
https://app.omnifox.io/docs. - Procure o endpoint, por exemplo
GET /v1/contacts. - Clique em "Try it out", cole seu token Bearer no botão de autorização (cadeado) no topo da página.
- Preencha os parâmetros que quiser testar (
tag,per_page, etc.) e execute. - O Swagger UI mostra o
curlequivalente, a URL final e a resposta real do seu workspace.
Dicas
- Use o botão de autorização uma única vez por sessão de navegador: o token fica aplicado a todos os endpoints que você testar depois.
- Se for construir seu próprio SDK, importe o
openapi.jsondiretamente no Postman ("Import > Link") para manter toda a coleção atualizada sem precisar montá-la manualmente.
Solução de problemas
- "Try it out" retorna 401: falta carregar o token Bearer no botão de autorização, ou o token expirou.
- O endpoint que preciso não aparece: a documentação cobre
/api/v1/*; recursos muito novos podem levar um ciclo de release para aparecer no spec público.
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.