Widget de chat

Todos os endpoints utilizados pelo widget de chat incorporado em websites de clientes.

Este grupo reúne todos os endpoints públicos utilizados pelo widget de chat incorporado em websites de clientes: Health Check (`GET /api/public/widget/health`), obtenção da configuração pública do widget (`GET /api/public/widget/config/:widget_code`) e envio/histórico de mensagens (`POST /api/public/widget/message`, `GET /api/public/widget/history`). A autorização de domínio é mantida pela Zentor ao criar o widget; não existe interface de configuração para isso no dashboard do tenant. Uma Origin não autorizada pode gerar `WIDGET_ORIGIN_DENIED`. A criação do widget é exclusiva do Master Admin, enquanto o tenant recebe o código final de incorporação.

Não existe um sistema geral de Developer API Key. `health` e `config` são acessíveis sem autenticação porque servem para inicializar o widget no browser. `message` e `history`, por outro lado, exigem o header `X-Widget-Token` e são adicionalmente verificados contra uma Origin Allowlist no servidor. O Embed Token é mostrado em texto simples uma única vez ao criar o widget e não deve aparecer em repositórios públicos, screenshots de suporte ou logs do browser.

Cada página detalhada deste grupo descreve individualmente método, caminho, autenticação, idempotência e códigos de erro documentados do respetivo endpoint. Uma chamada bem-sucedida a um endpoint não prova automaticamente que outro endpoint do mesmo grupo também funcionará — em particular, um `health` verde não confirma widget válido, Origin autorizada nem acessibilidade de um provider de IA.

O limite de API confirmado para toda a plataforma é 2.000 pedidos em 15 minutos. Um limite diferente para um endpoint individual do widget só é indicado quando comprovado expressamente. `message` não é idempotente; um cliente não deve repetir automaticamente um envio que terminou de forma ambígua sem verificar primeiro se a primeira mensagem já foi processada.

A verificação técnica deste grupo baseia-se na Registry em `app/frontend/src/content/api-reference/groups/widget.ts` e nas rotas backend associadas. Cada página detalhada indica se foi testado um caminho de sucesso live, um caminho negativo ou apenas uma analogia de código — esta distinção aplica-se a todo o grupo e não deve ser substituída por afirmações genéricas de sucesso.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
Referência API