Referência API

Endpoints API públicos para programadores: formulários, widget, configurador de produto e mais.

Esta referência descreve exclusivamente endpoints JSON reais e utilizáveis publicamente -- método, caminho, tipo de autenticação, parâmetros obrigatórios, pedido e resposta de exemplo, bem como os códigos de erro documentados para cada endpoint. A Zentor não dispõe de um sistema geral de chaves API para developers; consoante a rota, o acesso é feito sem autenticação ou através de um token de incorporação do widget com validação de origin. As rotas internas do Dashboard e os endpoints de Master Admin são deliberadamente excluídos desta referência pública, pois apenas são acessíveis através de uma sessão normal com sessão iniciada.

Cada entrada de endpoint inclui uma nota de teste live que indica de forma transparente se a informação provém do esquema do Registry, de um teste automatizado ou de uma observação live real -- a mera semelhança com um caminho de código funcional não é considerada prova completa. Além disso, uma chamada tecnicamente bem-sucedida confirma apenas o processamento do respetivo pedido, não confirmando automaticamente processos posteriores como entrega de e-mail, conclusão de pagamento ou um início de sessão SSO concluído.

A proteção depende do grupo em causa. Os endpoints públicos jurídicos, de marketing e de formulários não necessitam de uma sessão do Dashboard. O widget, por sua vez, utiliza o cabeçalho `X-Widget-Token` e uma Origin-Allowlist. Os logins do Dashboard fornecem um JWT de sessão com duração de doze horas e um refresh token válido por sete dias. Os endpoints SSO utilizam os seus próprios códigos de utilização única e fluxos de callback.

Leia cada página de endpoint como um contrato autónomo. São determinantes o método HTTP, o caminho, os parâmetros obrigatórios, os tipos de dados, o corpo do pedido, a estrutura da resposta, os códigos de erro e a idempotência. Um exemplo mostra um formato possível, mas não substitui a verificação da resposta real. O estado da configuração, as validações, as permissões e os fornecedores externos podem alterar o resultado.

O Rate Limit confirmado para toda a plataforma é de 2.000 pedidos em 15 minutos. Não existem limites separados por endpoint documentados de forma consistente. Por isso, os clientes não devem utilizar ciclos de polling desnecessariamente apertados. Em operações não idempotentes, as repetições automáticas podem criar registos ou mensagens duplicados.

Valores sensíveis não devem constar dos logs. Entre eles estão palavras-passe, reset tokens, códigos de verificação, widget tokens, session IDs e dados pessoais reais usados como exemplo. Utilize valores anonimizados na documentação e nos testes. As notas de teste live devem refletir corretamente a prova efetivamente disponível.

Autenticação (5)Login, renovação de token, reset de palavra-passe, troca SSO.Formulários públicos (11)Contacto, pedido de aconselhamento, pedido de acesso, ativação de conta.Configurador de produto (5)Lista de pacotes, pré-visualização de preços, verificação de e-mail, submissão de configuração.Conteúdos públicos (6)Textos jurídicos, páginas de marketing, configuração de tema e cores de texto.Widget de chat (9)Todos os endpoints utilizados pelo widget de chat incorporado em websites de clientes.Chatbot Demo e SSO (13)O chatbot Demo público e endpoints de Single Sign-On.
Voltar à visão geral