API e Webhooks
Abas
A página de API e Webhooks é onde sua equipe gerencia as ferramentas para conectar a PlatoForms a serviços externos: endpoints de webhook que enviam submissões de formulários para outros sistemas, aplicações OAuth2 para integrações de terceiros e tokens de longa duração para chamadas de API de servidor para servidor. Este capítulo explica como acessar a página e configurar cada um desses elementos.
Acesse a página de API e Webhooks
-
Faça login no seu Painel.
-
Na barra lateral esquerda, clique no nome da sua equipe para abrir o menu da equipe.
-
Selecione API e Webhooks na lista.
O que você verá com base nas suas permissões
Se você tiver acesso
A página abre diretamente em URL & Tokens da API, onde você pode visualizar e gerenciar seus webhooks, aplicações OAuth2 e tokens.
Os administradores da equipe sempre têm acesso direto a esta página.
Se você não tiver acesso
API e Webhooks é exibido com um ícone de cadeado e um rótulo “Solicitar acesso ao administrador”.
Clique em Solicitar acesso ao administrador para enviar uma solicitação.
O administrador da sua equipe recebe um e-mail notificando sobre a solicitação. Uma vez concedido o acesso, você poderá abrir API e Webhooks no menu da sua própria equipe.
Configure endpoints de Webhook
Configure endpoints para receber notificações em tempo real quando formulários são enviados ou outros eventos ocorrem. Útil para integrar dados de formulários em outras aplicações ou serviços.
Clique em + Adicionar endpoint para criar um novo, ou no ícone de edição ao lado de um endpoint existente para modificá-lo.
Ao adicionar ou editar um endpoint, você pode configurar:
| Campo | Descrição |
|---|---|
| Nome | Um rótulo para ajudar a identificar o endpoint. |
| URL do WebHook | A URL que receberá a solicitação POST. |
| Formulário Alvo | Escolha Todos os Formulários para acionar o webhook para qualquer submissão de formulário, ou selecione um formulário específico. |
| Incluir links compartilháveis | Inclua links de submissão compartilháveis na carga útil. |
| Dados de submissão como Dicionário (em vez de Lista) | Altere a estrutura dos dados de submissão na carga útil. |
| Hook Instantâneo (Sem esperar pela criação do PDF) | Dispare o webhook imediatamente em vez de esperar a geração do PDF da submissão. |
| Excluir dados de assinatura da carga útil | Omitir dados de assinatura da carga útil. |
| Webhook Ativado | Ative ou desative o endpoint sem excluí-lo (disponível ao editar um endpoint existente). |
Clique em Salvar para aplicar suas alterações, ou Excluir para remover o endpoint completamente.
Crie uma Aplicação OAuth2
As APIs da PlatoForms são protegidas pelo protocolo OAuth2, uma estrutura segura de autenticação e autorização. Uma “Aplicação OAuth2” refere-se a uma aplicação registrada que utiliza OAuth 2.0 para interação com o sistema.
Ao criar uma aplicação OAuth2, você pode obter com segurança um ID do Cliente e um Segredo do Cliente através de um processo de autenticação. Isso, por sua vez, facilita a autorização segura de outras aplicações para acessar a API da plataforma. A criação de uma ‘Aplicação OAuth2’ configura os componentes essenciais para uma integração segura, permitindo interações com a API usando OAuth2 tanto para autenticação quanto para autorização.
Para criar uma Aplicação OAuth2:
-
Clique em + Adicionar aplicação.
-
Na janela que se abre:
-
Forneça um Nome para sua aplicação, que ajuda a identificá-la dentro do sistema.
-
Especifique uma URL de Redirecionamento, que é crucial para o fluxo OAuth2.
-
-
Confirme suas configurações clicando em Salvar.
Uma vez que a aplicação é salva, o sistema gera um ID do Cliente e um Segredo do Cliente únicos.
Crie e redefina seu token
Se você é um desenvolvedor que precisa de acesso prolongado à API, a plataforma oferece a capacidade de criar e redefinir o Token Sem Expiração da sua equipe. Este recurso elimina a necessidade de atualização regular do token, garantindo acesso ininterrupto e prolongado à API para solicitações de servidor para servidor. Cada equipe possui um único token sem expiração.
Basta clicar em Criar ou redefinir para gerar o token, e usar Excluir para removê-lo quando necessário. Esta funcionalidade simplifica o processo de gerenciamento de acesso a longo prazo à API.
Trate tokens, IDs de Cliente e Segredos de Cliente como senhas. Qualquer pessoa com acesso a eles pode acessar os dados da sua equipe.
Se você preferir trabalhar com seus formulários de forma conversacional por meio de um assistente de IA — sem escrever nenhum código — consulte Assistente de IA (MCP).