Tema
Chaves API
As Chaves API permitem integrar o ModPro com sistemas externos, como websites ou plataformas de marketing, para captação automática de leads.
Aceder
Aceda a Configurações > Chaves API no menu lateral.
NOTA
A gestão de Chaves API está disponível apenas para o Super Administrador.
O que é uma chave API?
Uma chave API é um código de autenticação que permite a sistemas externos enviar dados para o ModPro de forma segura. A principal utilização é a captação de leads — quando alguém preenche um formulário no seu website, os dados são enviados automaticamente para o ModPro.
Criar uma chave
- Clique em Criar chave
- Preencha os campos:
| Campo | Descrição | Obrigatório |
|---|---|---|
| Nome | Designação descritiva (ex: "Website principal") | Sim |
| Utilizador Padrão | Utilizador ao qual os leads serão atribuídos por defeito | Não |
| Ativa | Se a chave está activa | — |
| Limite de Pedidos por Minuto | Máximo de pedidos por minuto (predefinido: 10, máximo: 100) | — |
| Domínios Permitidos | Domínios autorizados a utilizar esta chave | Não |
Segurança
Limite de pedidos
O Limite de Pedidos por Minuto protege contra uso abusivo. O valor predefinido é 10 pedidos por minuto, adequado para a maioria dos formulários.
Domínios permitidos
O campo Domínios Permitidos restringe quais websites podem utilizar a chave. Apenas pedidos originados dos domínios listados serão aceites.
ATENÇÃO
Mantenha as chaves API seguras. Não partilhe publicamente e utilize sempre restrições de domínio.
Estatísticas de utilização
Para cada chave, pode consultar:
| Indicador | Descrição |
|---|---|
| Total de utilizações | Número total de pedidos processados |
| Última utilização | Data/hora do último pedido |
| Leads Criados | Número de leads criados com esta chave |
| Criada em | Data de criação da chave |
Instruções de integração
Cada chave possui uma página de Instruções de Integração com detalhes sobre como configurar a integração no seu website ou sistema.
Configuração do formulário
A página de Configuração do Formulário fornece orientações sobre como criar o formulário de captação que enviará dados para o ModPro.
Consulte Captação de Leads para detalhes sobre o formulário público.
Desactivar uma chave
Para suspender temporariamente uma chave sem a eliminar:
- Edite a chave
- Desactive o toggle Ativa
- Guarde as alterações
Os pedidos com chaves desactivadas serão rejeitados automaticamente.