Pular para o conteúdo principal

Documentação para desenvolvedores

Bem-vindo à área Desenvolvedor do Workfuse — tudo que você precisa para integrar sistemas externos à plataforma via API REST.

A API é organizada em módulos (produtos), todos compartilhando os mesmos fundamentos de autenticação e webhooks. Você integra uma vez e habilita módulos conforme contrata.

Por onde começar

SeçãoO que tem
PlataformaFundamentos comuns a todos os módulos: Autenticação (API keys) e Webhooks.
MódulosAPIs por produto. Disponível agora: Correção de Redação.
Referência da APISwagger interativo (OpenAPI) para explorar e testar todos os endpoints.

Fundamentos

  • Base URL: API_BASE/public/v1API_BASE é a URL da API do seu ambiente (em produção, https://api.workfuse.com).
  • Autenticação: API key por instituição, no header Authorization: Bearer wf_.... Veja Autenticação.
  • Formato: JSON em request e response; campos e erros documentados por endpoint.
  • Referência interativa: Swagger com try-it-out.

Quem deve ler

  • Equipes de TI que integram o Workfuse com sistemas internos da instituição.
  • Parceiros que constroem em cima da plataforma.
  • Times de produto avaliando a viabilidade técnica de uma integração.

Para clientes (não-técnico)

Se você é PO/PM/admin e quer entender o produto pela perspectiva de uso, vá para a Documentação do Produto. Esta área é puramente técnica.