Tokens de API
Os tokens de API permitem ligar sistemas externos, scripts e ferramentas à plataforma Mirox com credenciais delimitadas e revogáveis que nunca expõem a sua palavra-passe. Cada token autentica pedidos máquina-a-máquina em seu nome, para que possa automatizar relatórios e exportar métricas sem partilhar o seu início de sessão.
Conceito de Token
Cada token pertence ao utilizador que o criou e comporta-se como esse utilizador, dentro de limites:
- Associado à sua conta — um token atua em seu nome e tudo o que faz é-lhe atribuído no rasto de auditoria.
- Teto de permissões — um token nunca pode alcançar nada que o próprio utilizador não consiga alcançar. A sua função e o seu acesso a recursos limitam sempre o que o token vê.
- Delimitado por grupo de permissões — escolhe um grupo de permissões no momento da criação para restringir ainda mais o token (ver abaixo).
- Mostrado uma única vez — o valor completo do token é apresentado uma única vez quando o cria. Guarde-o de forma segura; a Mirox mantém apenas uma cópia em hash e nunca o poderá mostrar novamente.
Isto mantém a automatização responsável: mesmo que um token seja comprometido, está limitado a um único âmbito, é fácil de revogar e está isolado dos seus restantes tokens.
Grupos de Permissões
Ao criar um token, escolhe um grupo de permissões que define o que ele pode fazer:
| Grupo | O que o token pode fazer |
|---|---|
| Full Access | Atua com o seu acesso completo — todas as superfícies de API que consegue alcançar. |
| Reporting | Gerar e descarregar apenas relatórios e exportações. |
| Timeseries Database | Ler apenas métricas de séries temporais. |
Um grupo nunca alarga o seu acesso; apenas restringe o token em relação às suas próprias permissões. Para a definição completa de cada grupo, consulte a secção grupos de permissões de API da documentação do sistema de permissões.
Adeque o grupo à tarefa
Atribua a cada integração o grupo mais restrito que ainda funcione. Uma tarefa de relatório noturno precisa apenas de Reporting; um cliente de leitura de métricas precisa apenas de Timeseries Database. Isto limita o raio de impacto caso um token seja comprometido.
Criar e Gerir Tokens
Gere os seus tokens a partir do seu perfil. A plataforma cobre todo o ciclo de vida:
Criar um Token
- Nome e descrição — uma etiqueta clara e uma nota para que se lembre da finalidade de cada token.
- Grupo de permissões — escolha um dos grupos acima.
- Expiração — opcional. Os tokens têm por predefinição um período de validade de um ano, podendo definir qualquer data de expiração até um máximo de cinco anos.
- Revelação única — o token completo é mostrado uma única vez na criação e nunca mais.
Pode ter até 64 tokens ativos por conta.
Criar e rodar exigem uma sessão com início de sessão
Criar, rodar ou eliminar um token requer um início de sessão ativo no navegador (sessão por cookie). Não pode usar um token de API para emitir ou rodar outro — isto impede que um token comprometido crie discretamente mais tokens.
Rodar um Token
A rotação substitui o segredo de um token no local, sem alterar o seu nome, descrição ou grupo de permissões:
- É emitido um novo segredo, mostrado uma única vez.
- O segredo antigo deixa de funcionar imediatamente.
- A expiração é reposta e o histórico de utilização é limpo.
A rotação é a forma recomendada de renovar integrações de longa duração de forma periódica, ou de responder a uma suspeita de comprometimento, sem reconfigurar qual integração usa qual token.
Monitorizar e Revogar
- Inventário — liste todos os seus tokens com o respetivo nome, grupo de permissões e datas de criação e expiração.
- Informação de utilização — veja quando cada token foi usado pela última vez, juntamente com o IP, localização, navegador e sistema operativo captados nesse momento. O valor do token em si nunca volta a ser mostrado.
- Revogação imediata — elimine um token para o invalidar instantaneamente. Revogar um token nunca afeta os restantes.
Casos de Uso Comuns
Os tokens de API suportam uma vasta gama de cenários de integração.
Relatórios e Exportação de Dados
- Agende a geração e o descarregamento automáticos de relatórios.
- Alimente armazéns de dados e pipelines de análise com dados de desempenho.
- Potencie dashboards externos e ferramentas de relatórios executivos.
Acesso a Métricas de Séries Temporais
- Consulte métricas históricas com MiroxQL, o formato de consulta suportado para acesso programático e a dados em bruto.
- Ligue ferramentas de análise só de leitura à API de exportação de métricas.
- Extraia métricas históricas para análise de tendências e dashboards externos.
Segurança e Controlo
- Isolamento de tokens — um token comprometido nunca expõe a sua palavra-passe nem os seus restantes tokens.
- Rotação agendada — rode tokens de longa duração periodicamente através da ação de rotação, mantendo a mesma configuração.
- Validade temporal — defina uma expiração para que tokens abandonados caduquem automaticamente.
- Atribuição completa — todas as ações que um token realiza são registadas em seu nome, mantendo a utilização responsável e auditável.
Funcionalidades Relacionadas
- Sistema de Permissões — como funcionam os grupos de permissões e o controlo de acesso
- Relatórios — geração automática de relatórios que um token pode acionar
- MiroxQL — consulte métricas históricas com um token Timeseries Database
- Guia de Utilização de Tokens de API — criação de tokens passo a passo e exemplos