Skip to content

Claves API

Mantenido por: Aether365 Team Audiencia: Desarrolladores Alcance: Endpoints de gestión de claves API

Las claves API se utilizan para autenticar solicitudes a la API REST sin una sesión de usuario.

Cada clave API está vinculada a la cuenta del tenant que la creó. Las claves API tienen el mismo acceso que un miembro del equipo - pueden leer y escribir todos los datos del tenant pero no pueden cambiar la facturación ni la configuración del plan.

Listar claves API

Devuelve todas las claves API activas del tenant.

GET /tenants/me/api-keys

INFO

Por seguridad, el valor completo de la clave solo se devuelve una vez - en el momento de la creación. Las solicitudes de lista posteriores muestran solo el prefijo de la clave y los metadatos.

Solicitud de ejemplo

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

Respuesta de ejemplo

json
{
  "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 de respuesta

CampoTipoDescripción
idstringIdentificador de la clave
namestringNombre para mostrar
prefixstringPrimeros 12 caracteres de la clave (para identificación)
createdAtstringMarca de tiempo ISO 8601
lastUsedAtstring o nullMarca de tiempo ISO 8601 del último uso autenticado

Crear una clave API

Crea una nueva clave API. El valor completo de la clave se devuelve una sola vez y no se puede recuperar después.

POST /tenants/me/api-keys

Cuerpo de la solicitud

json
{
  "name": "CI pipeline"
}
CampoTipoObligatorioDescripción
namestringSiNombre para mostrar de la clave

Solicitud de ejemplo

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

Respuesta de ejemplo

json
{
  "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
  }
}

Guarda la clave inmediatamente

El campo key solo se devuelve en esta respuesta. No se puede recuperar después. Guárdala en un gestor de secretos (GitHub Actions secrets, HashiCorp Vault, etc.) de inmediato.


Eliminar una clave API

Revoca permanentemente una clave API. Cualquier solicitud que utilice esta clave devolverá 401 de inmediato.

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

Solicitud de ejemplo

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

Respuesta de ejemplo

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

Uso de una clave API

Pasa la clave API como token Bearer en la cabecera Authorization:

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

Las claves API funcionan igual que los tokens de sesión para todos los endpoints. No caducan, pero puedes rotarlas creando una nueva clave y eliminando la antigua.

Limites de tasa

La API tiene un límite de 120 solicitudes por minuto por clave API. Las solicitudes que superen el límite reciben una respuesta 429 Too Many Requests. La respuesta incluye una cabecera Retry-After que indica cuando puedes reintentar.

¿Te resultó útil esta página?