Criar e gerir chaves de API
Emitir chaves de API Piloterr, definir quotas e rodá-las em segurança.
As chaves de API autenticam todos os pedidos. Faz a sua gestão em Chaves API, na barra lateral, onde cada chave tem um nome, uma categoria, limites de janela deslizante opcionais e uma data de expiração opcional.
Chaves API
Nova chave de APICriar uma chave
Abrir o formulário
Aceda a Chaves API e clique em Nova chave de API.
Preencher os campos
Dê à chave um Nome que reconheça nos registos (prod-api, zapier, local-dev), escolha uma Categoria e, se quiser, defina uma data de expiração.
Definir limites de pedidos
O separador Limites de solicitação limita quanto uma única chave pode gastar. Deixe os campos vazios para uma chave sem limite.
Copiar o segredo
O segredo é apresentado uma única vez, logo após a criação. Copie-o para o seu gestor de segredos ou para as variáveis de ambiente. Se o perder, crie uma nova chave — não é possível recuperá-lo.
Segredo — mostrado uma vez
Limites por chave
| Limite | Conta |
|---|---|
| Limite global rígido | Todos os pedidos que a chave alguma vez fez. |
| Em 24h | As últimas 24 horas, em janela deslizante. |
| Em 7d | Os últimos 7 dias, em janela deslizante. |
| Em 30d | Os últimos 30 dias, em janela deslizante. |
As janelas deslizam continuamente, em vez de se reporem à meia-noite ou no dia 1. Uma chave que atinge o seu limite devolve 401 com uma mensagem a identificar a quota, enquanto as restantes chaves continuam a funcionar.
Uma chave por ambiente
| Ambiente | Categoria | Porquê |
|---|---|---|
| Desenvolvimento local | development | Revogar à vontade sem tocar na produção. |
| CI e pré-produção | staging | Isolar o tráfego de testes automáticos nos registos. |
| Produção | production | Rodar com regularidade e vigiar de perto. |
Desativar, eliminar ou rodar
- Desativar bloqueia a chave de imediato e mantém o histórico. Use assim que uma chave possa ter sido exposta.
- Eliminar só é possível para chaves que nunca foram utilizadas. Tudo o que tem histórico de pedidos é conservado para faturação e auditoria.
- Rodar é criar primeiro a chave de substituição, implementá-la em todo o lado e só depois desativar a antiga. Esta ordem evita interrupções.
Uma chave exposta pode gastar todo o seu saldo. Desative-a de imediato e crie uma substituta — não espere pela próxima rotação.