Explorar a API com o Swagger UI (/docs) e o arquivo OpenAPI

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/data e code/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

1. Acesse https://app.omnifox.io/docs.
2. Procure o endpoint, por exemplo GET /v1/contacts.
3. Clique em "Try it out", cole seu token Bearer no botão de autorização (cadeado) no topo da página.
4. Preencha os parâmetros que quiser testar (tag, per_page, etc.) e execute.
5. O Swagger UI mostra o curl equivalente, 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.json diretamente 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.