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:
Como autenticar no Swagger
Clique em Authorize e cole só a sua API key, wf_...
(veja Autenticação): o Swagger acrescenta o Bearer sozinho, e
Bearer wf_... no campo responde 401. As chamadas de teste passam a ir assinadas com a sua
chave.
Módulos no contrato
| Grupo | Módulo | Guia |
|---|---|---|
Correction | Correção de Redação | Correção de Redação |
Admission | Processo Seletivo — a página de inscrição, a consulta da situação e a nota da prova | Processo Seletivo |
CRM | Contatos e eventos | API de CRM |
Próximos módulos no roadmap
A API cresce por módulo. No roadmap:
- CRM — contatos e eventos. O contrato já está desenhado e aberto para discussão:
prévia da API de CRM (os endpoints ainda não respondem, com
exceção de
POST /crm/events). - Tickets — criação, atribuição, atualização de status.
- Comunicação — disparar notificações por API.
- Versionamento — política de breaking changes. Os limites de requisição já estão desenhados em Limites e cotas.