Pular para o conteúdo

API keys

API keys é onde você gera os Bearer tokens que agentes, integrações e dashboards customizados usam para chamar api.saiku.bi. Você virá aqui uma vez para cada integração que quiser configurar e periodicamente depois para rotação.

A página lista todas as chaves do seu tenant com rótulo, ID parcial da chave, criador, data de criação e um timestamp de último uso que atualiza quase em tempo real. Útil para identificar chaves que não estão sendo usadas (revogue-as) e chaves que estão sendo muito usadas (as candidatas certas para uma revisão de rotação).

Gerar uma chave

  1. Clique em Criar chave e dê um rótulo. Use um nome que descreva para que ela serve: production-billing-agent, staging-bot, client-acme-integration. Os rótulos aparecem no audit log, então torne-os reconhecíveis.

  2. Clique em Criar.

  3. Copie o segredo imediatamente. Ele aparece uma única vez. O dashboard mantém o ID e o rótulo da chave depois desse ponto, mas o segredo em si não é mais recuperável — não o guardamos em forma reversível.

  4. Cole no armazenamento de segredos da sua integração. Teste de ponta a ponta.

Usar a chave

Envie o segredo no header Authorization:

Terminal window
curl https://api.saiku.bi/me/tenant \
-H "Authorization: Bearer sk_live_…"

A referência completa fica em Autenticação — URL base, limites de taxa, formato de erro, tudo.

Rotação

Uma rotação limpa tem zero indisponibilidade porque ambas as chaves são válidas durante a transição.

  1. Crie uma nova chave com o mesmo rótulo da antiga (acrescente -v2, -v3 para diferenciá-las).
  2. Implante a nova chave na sua integração.
  3. Confirme que a nova chave está sendo usada — a coluna Last used na página atualiza em um ou dois minutos.
  4. Revogue a chave antiga assim que estiver confiante.

Revogar

Ícone de lixeira na linha, confirme. A chave é invalidada imediatamente — a próxima requisição usando-a recebe 401 Unauthorized. Não há período de carência nem desfazer, então revogue deliberadamente.

Limites de taxa

Limites de taxa são por tenant, não por chave, então espalhar a carga em múltiplas chaves não dará mais folga — apenas espalhará as batidas no seu orçamento total. Veja Autenticação para os limites por tier.

Chaves por agente

Boa prática para qualquer implantação não trivial: uma chave por integração. Se um agente for comprometido, você revoga a chave dele sem afetar nenhuma outra. Se quiser saber qual integração é responsável por uma requisição específica, a coluna de ID de chave do audit log diz imediatamente.

O custo dessa prática é próximo de zero — chaves são baratas de gerar e o dashboard não fica difícil de gerenciar até você ter dezenas delas.

Relacionado

  • Autenticação — usando chaves nas requisições.
  • Audit log — a chave de cada requisição é registrada.
  • Usage — volume de requisições por chave.