Descrição: Ferramenta essencial para a criação, visualização e gestão dos tokens de acesso (API Key) usados para conectar o Framework360 com serviços e aplicações externas.
Para que serve? (Exemplos práticos)
Esta ferramenta é fundamental quando é necessário fazer o Framework360 interagir com sistemas externos de forma controlada e segura.
- Integração com Software de Terceiros: Use-a para gerar uma chave dedicada que permita a um software de contabilidade ou a um conector de dados (ETL) acessar apenas as funções necessárias (ex. leitura dos pedidos).
- Desenvolvimento de Apps Mobile/Web Customizadas: Útil para criar um token que permita a uma aplicação móvel desenvolvida ad hoc executar chamadas específicas (ex. registro de um novo usuário) dentro do sistema.
- Controle de Acessos: Permite limitar exatamente quais operações (ex. modificação, criação, leitura) podem ser executadas por cada integração individual, aumentando a segurança do sistema.
Funcionalidades principais
1. Gestão das Chaves
- Criação Simples: É possível gerar uma nova chave API com um único clique, fornecendo um nome descritivo. O sistema gera automaticamente um Token único de 40 caracteres.
- Monitoramento: A lista principal mostra a última data de uso de cada chave, permitindo identificar rapidamente as chaves inativas ou aquelas usadas com frequência.
- Eliminação: Permite revogar imediatamente o acesso eliminando a chave.
2. Configuração das Permissões (Granularidade)
O aspecto mais importante é a possibilidade de definir com precisão o que cada chave pode fazer.
- Definição das Funções: Por meio de uma estrutura em abas e checkboxes, o usuário pode selecionar quais funções API específicas (ex.
creacliente,eliminaprodotto,leggi_campagna) estão habilitadas para aquele Token. - Seleção Múltipla: Está disponível um botão "Selecionar tudo" para habilitar rapidamente todas as funções.
Como configurar
Ao modificar uma chave API, acessa-se a tela de configuração dividida em duas seções principais: Configurações Gerais e Permissões.
Configurações Gerais
| Opção | Descrição |
|---|---|
| Api Key | O Token único gerado pelo sistema. Deve ser fornecido à aplicação externa. |
| Data de criação | Data em que a chave foi gerada. |
| Requer autenticação do usuário | Se esta opção estiver ativa, a chave API não será suficiente sozinha. Cada chamada API deverá incluir também um Token válido da sessão do usuário (via header X-Fw360-UserToken). |
Gestão de Permissões por Papel
O sistema de gestão de permissões é organizado por Papéis do Usuário. Isso permite definir conjuntos diferentes de permissões dependendo do contexto em que a chave é usada.
1. Navegação por Abas: As abas (ou "steps") na seção Permissões correspondem aos diferentes Papéis configurados no sistema (ex. Administrador, Cliente, Agente).
2. Atribuição das Funções: Dentro de cada aba, é possível selecionar as funções API a serem habilitadas.
3. Limitação por Papel: Para papéis diferentes do Administrador, o sistema alerta que as chamadas feitas com aquela chave respeitarão também as limitações já definidas para aquele Papel no módulo de Gestão de Papéis.
4. Segurança Adicional (Ícone Cadeado): Ao lado de algumas funções API pode aparecer um ícone em forma de cadeado. Se selecionado, significa que aquela função específica, mesmo habilitada pela chave API, exigirá obrigatoriamente que a chamada seja acompanhada por uma autenticação válida do usuário (mesmo se a opção geral "Requer autenticação do usuário" não estiver ativa).
Integrações automáticas
Este módulo é o ponto de acesso para todas as integrações externas. Sua configuração influencia diretamente a capacidade dos sistemas externos interagirem com os dados e funcionalidades do Framework360.
Controle do Acesso do Usuário: Se ativar a opção "Requer autenticação do usuário", a chave API não só autentica a aplicação, mas também vincula a chamada às permissões específicas do usuário que está usando a aplicação externa. Isso garante que, por exemplo, um cliente possa ler apenas seus próprios dados, mesmo se a chave API estiver configurada para acesso genérico.
