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:

• Swagger: https://api.workfuse.com/public/v1/doc
• OpenAPI: https://api.workfuse.com/public/v1/openapi

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.

Convenções

include

Algumas rotas devolvem o recurso enxuto e expandem relações sob pedido, com ?include= (valores separados por vírgula). As regras valem para toda a API:

• A relação expandida é sempre um objeto (ou lista) na chave com o nome dela.
• Ponto indica o nível seguinte, até 2 níveis (contact.consents); o filho pedido expande o pai junto.
• Lista relacionada só vem com include; sem ele, a resposta é a mesma de antes.
• O objeto expandido tem a mesma representação do recurso quando lido sozinho.
• Rótulo de cadastro (origem, por exemplo) vem embutido como { id, name }.
• A lista resume, o detalhe completa: relações pesadas ficam na leitura de um item.
• Bloco sensível só sai sob pedido.
• include desconhecido responde 400 (INVALID_INCLUDE), com os valores aceitos em details.accepted.

Onde vale hoje:

Rota	Valores aceitos
GET /crm/contacts/{contactId}	consents — veja Contatos
GET /crm/form-submissions	form, contact, contact.consents, channelConsents — veja Envios de formulário
GET /crm/form-submissions/{id}	form, contact, contact.consents, channelConsents, evidence — veja Ler um envio

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, negócios, eventos, consentimentos, origens de consentimento e e-mails transacionais	API de CRM · E-mails transacionais
E-mail	Envio de e-mail a partir de um modelo	Envio de e-mail

Próximos módulos no roadmap

A API cresce por módulo. No roadmap:

• 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.