API e Webhooks
Abas
Este capítulo é um guia para desenvolvedores que utilizam a página de API e Webhooks. Obtenha insights sobre como aproveitar essas ferramentas.
Acesse a página de API e Webhooks
-
Faça login no seu Painel de Controle.
-
No canto superior direito do Painel de Controle, clique na sua foto de perfil e escolha API Webhooks.
Verifique o status do acesso à API
Na página que se abre, você pode verificar o status do seu acesso à API.
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 Editar para modificar um endpoint existente.
Crie uma Aplicação OAuth2
As APIs do 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 o OAuth 2.0 para interagir 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, 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 tokens
Se você é um desenvolvedor que requer acesso prolongado à API, a plataforma oferece a capacidade de criar e redefinir tokens sem expiração. Este recurso elimina a necessidade de atualização regular de tokens, garantindo acesso contínuo e prolongado à API.
Basta clicar em Criar ou Redefinir Token para gerar um novo token e usar Excluir para remover um token existente quando necessário. Esta funcionalidade simplifica o processo de gerenciamento de acesso a longo prazo à API.