Chaves API

As chaves API são utilizadas para autenticar pedidos a API REST sem uma sessão de utilizador.

Cada chave API está vinculada a conta de tenant que a criou. As chaves API tem o mesmo acesso que um membro da equipa - podem ler e escrever todos os dados do tenant, mas não podem alterar faturação ou definições do plano.

Listar Chaves API

Devolve todas as chaves API ativas para o tenant.

GET /tenants/me/api-keys

INFO

Por segurança, o valor completo da chave só é devolvido uma vez - no momento da criação. Pedidos de listagem subsequentes mostram apenas o prefixo da chave e metadados.

Exemplo de Pedido

curl https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>"

Exemplo de Resposta

{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI pipeline",
      "prefix": "ae_live_abc1",
      "createdAt": "2026-03-01T09:00:00Z",
      "lastUsedAt": "2026-04-10T14:23:00Z"
    }
  ]
}

Campos da Resposta

Campo	Tipo	Descrição
id	string	Identificador da chave
name	string	Nome de apresentação
prefix	string	Primeiros 12 caracteres da chave (para identificação)
createdAt	string	Data e hora ISO 8601
lastUsedAt	string ou null	Data e hora ISO 8601 do último pedido autenticado

---

Criar uma Chave API

Cria uma nova chave API. O valor completo da chave e devolvido uma vez e não pode ser recuperado novamente.

POST /tenants/me/api-keys

Corpo do Pedido

{
  "name": "CI pipeline"
}

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome de apresentação da chave

Exemplo de Pedido

curl -X POST https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Exemplo de Resposta

{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI pipeline",
    "key": "ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "prefix": "ae_live_abc1",
    "createdAt": "2026-04-12T10:00:00Z",
    "lastUsedAt": null
  }
}

Guarde a chave imediatamente

O campo key só e devolvido nestá resposta. Não pode ser recuperado posteriormente. Guarde-o num gestor de segredos (GitHub Actions secrets, HashiCorp Vault, etc.) imediatamente.

---

Eliminar uma Chave API

Revoga permanentemente uma chave API. Quaisquer pedidos que utilizem está chave devolverão 401 imediatamente.

DELETE /tenants/me/api-keys/{keyId}

Exemplo de Pedido

curl -X DELETE https://api.aether365.io/tenants/me/api-keys/key_abc123 \
  -H "Authorization: Bearer <token>"

Exemplo de Resposta

{
  "success": true,
  "data": null
}

---

Utilizar uma Chave API

Passe a chave API como token Bearer no cabecalho Authorization:

curl https://api.aether365.io/tenants/me/scans \
  -H "Authorization: Bearer ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

As chaves API funcionam da mesma forma que os tokens de sessão para todos os endpoints. Não expiram, mas pode roda-las criando uma nova chave e eliminando a antiga.

Limites de Taxa

A API está limitada a 120 pedidos por minuto por chave API. Os pedidos que excedam o limite de taxa recebem uma resposta 429 Too Many Requests. A resposta inclui um cabecalho Retry-After indicando quando pode tentar novamente.