Pular para o conteúdo principal

Autenticação

A API do Workfuse usa API keys por instituição. Cada requisição leva a chave no header Authorization, no formato Bearer:

Authorization: Bearer wf_sua_chave_aqui

Gerar uma chave

No painel, vá em Configurações → API Keys (requer perfil de administrador) e crie uma chave. A chave em claro (prefixo wf_) é exibida uma única vez no momento da criação — copie e guarde com segurança; não é possível vê-la de novo.

Escopo

Cada chave:

  • pertence a uma instituição da sua organização — você só acessa os dados daquela instituição;
  • tem escopo por módulo — só acessa os módulos habilitados nela. Chamar um endpoint de um módulo fora do escopo retorna 403 (ex.: a API de Correção exige o módulo correction).

Use o princípio do menor privilégio: uma chave por integração, só com os módulos que ela precisa.

Revogar / rotacionar

Em Configurações → API Keys você pode revogar uma chave a qualquer momento (ela para de funcionar imediatamente). Para rotacionar, crie uma nova chave, atualize a integração e revogue a antiga.

Erros de autenticação

HTTPSignificado
401Header Authorization ausente, malformado, ou chave inválida/revogada.
403Chave válida, mas sem o módulo necessário no escopo.