API Key
O módulo de API Key é utilizado para gerenciar as chaves de acesso à API pública do sistema, permitindo que aplicações externas ou o próprio Agente IA se comuniquem com o QD Painel de forma autenticada e segura.
Cada chave cadastrada possui um conjunto de permissões, limite de requisições e tempo de expiração, garantindo um controle refinado sobre quem pode acessar a API e o que pode fazer com ela.
Na listagem, é possível visualizar as chaves já cadastradas, contendo as seguintes informações:
- Nome: identificação da chave criada, utilizada para facilitar a organização;
- Prefixo: identificador parcial exibido da chave, usado para reconhecê-la sem expor o valor completo;
- Escopos: resumo das permissões definidas para aquela chave;
- Rate Limit: limite de requisições por minuto permitidas para a chave;
- Expira em: data limite de validade da chave ou indicação de "Sem expiração";
- Status: indica se a chave está ativa ou inativa no sistema.
No topo da tela, um aviso traz o endereço para acessar a documentação da API, acompanhado das credenciais necessárias (usuário e senha) para consultá-la. Para cadastrar uma nova chave, utilize o botão + NOVA CHAVE.
Configuração da chave
Ao criar uma nova chave, é exibida a tela Nova Chave de API, onde devem ser definidas as informações e permissões da credencial.
Nesta tela estão disponíveis os seguintes campos:
- Nome da chave: defina um nome que identifique claramente a finalidade da chave, como por exemplo o nome da aplicação que a utilizará;
- Rate Limit (req/min): selecione o limite de requisições por minuto. Esse controle evita o consumo excessivo da API;
- Expira em (opcional): informe a data de expiração da chave. Se deixado em branco, a chave não terá data de expiração;
- Selecionar todos / Desmarcar todos: atalhos para marcar ou desmarcar rapidamente todos os escopos disponíveis;
- Escopos de acesso: defina, módulo a módulo, quais permissões de Leitura e Escrita a chave terá. É possível, por exemplo, liberar apenas leitura de Produtos e Clientes, mantendo os demais módulos bloqueados.
Agente IA (Acesso Total)
A opção Agente IA (Acesso Total) deve ser utilizada quando a chave for destinada exclusivamente ao Agente IA do sistema.
Ao marcar essa opção, a chave é configurada como um perfil exclusivo para o Agente, liberando acesso completo aos módulos necessários para que ele consiga interagir com o sistema de ponta a ponta, executando criações, edições e consultas nos diversos recursos disponíveis.
Atenção
A opção Agente IA (Acesso Total) concede permissões amplas ao sistema. Utilize-a apenas em chaves destinadas ao próprio Agente IA e mantenha essa credencial em ambiente seguro. Para integrações externas, prefira configurar os escopos manualmente, liberando apenas o necessário para cada caso de uso.