Referência da API (Swagger)
A referência completa e interativa da API vive no Swagger, gerado a partir do contrato OpenAPI. Lá você navega por todos os endpoints, vê os schemas de request/response e testa as chamadas direto do navegador (try-it-out).
| Recurso | URL |
|---|---|
| Swagger interativo | API_BASE/public/v1/doc |
| Contrato OpenAPI (JSON) | API_BASE/public/v1/openapi |
API_BASE é a URL da API Workfuse do seu ambiente (em produção,
https://api.workfuse.com). Em produção:
Como autenticar no Swagger
Clique em Authorize e informe sua API key no formato Bearer wf_...
(veja Autenticação). As chamadas de teste passam a ir
assinadas com a sua chave.
Próximos módulos no roadmap
A API cresce por módulo. Hoje o módulo disponível é a Correção de Redação. No roadmap:
- Contatos — CRUD + busca.
- Tickets — criação, atribuição, atualização de status.
- Comunicação — disparar notificações por API.
- Rate limiting e versionamento — política de limites e breaking changes.